public class

SharepointConnector

extends Object
java.lang.Object
   ↳ org.mule.modules.sharepoint.SharepointConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

SharePoint is a web application platform for content and document management, intranet portals, collaboration, extranets, websites, and enterprise search. Mule SharePoint connector enables integrating with SharePoint.

Summary

Fields
private Client client
private boolean connected
private Object connectedLock
private JerseyUtil jerseyUtil
private SharepointAlertsClient sharepointAlertClient
private SharepointAuthenticationClient sharepointAuthenticationClient
private SharepointCopyClient sharepointCopyClient
private SharepointDwsClient sharepointDwsClient
private SharepointEmailClient sharepointEmailClient
private SharepointFormsClient sharepointFormClient
private SharepointImagingClient sharepointImagingClient
private SharepointListClient sharepointListClient
private SharepointMeetingsClient sharepointMeetingsClient
private SharepointPeopleClient sharepointPeopleClient
private SharepointPermissionsClient sharepointPermissionsClient
private SharepointQueryClient sharepointQueryClient
private SharepointSiteDataClient sharepointSiteDataClient
private SharepointSitesClient sharepointSitesClient
private SharepointUserGroupClient sharepointUserGroupClient
private SharepointVersionsClient sharepointVersionsClient
private SharepointViewsClient sharepointViewsClient
private SharepointWebPartPagesClient sharepointWebPartPagesClient
private SharepointWebsClient sharepointWebsClient
Public Constructors
SharepointConnector()
Public Methods
ArrayOfDeleteFailure alertDeleteAlerts(AlertArrayOfString iDs)
Deletes the specified alerts within a Web site.
AlertInfo alertGetAlerts()
Returns information about the alerts within a Web site.
LoginResult authLogin(String user, String pass)
Used in a forms-based authentication system to either set an authentication cookie or, if there is a problem with the logon, return an error code.
AuthenticationMode authMode()
Returns the authentication mode for the current SharePoint site.
void connect(String username, String password, String serverUrl)
Connect to the Sharepoint service
String connectionId()
Are we connected
void copyCopyIntoItems(String sourceUrl, DestinationUrlCollection destinationUrls, FieldInformationCollection fields, ByteArrayOutputStream stream, Holder<Long> copyIntoItemsResult, Holder<CopyResultCollection> results)
Copies a document represented by a Byte array to one or more locations on a server.
void copyCopyIntoItemsLocal(String sourceUrl, DestinationUrlCollection destinationUrls, Holder<Long> copyIntoItemsLocalResult, Holder<CopyResultCollection> results)
Copies a document from one location on a server running Microsoft SharePoint Foundation to another location on the same server.
void copyGetItem(String url, Holder<Long> getItemResult, Holder<FieldInformationCollection> fields, Holder<byte[]> stream)
Generates a Byte array representation of a document that can be passed to the CopyIntoItems method to copy the document to a different server.
void disconnect()
Disconnect
String dwsCanCreateDwsUrl(String url)
Determines whether the user has sufficient rights to create a Document Workspace site with the proposed URL on the server.
String dwsCreateDws(String documentUrl, String users, String title, String documents)
Creates a Document Workspace site and optionally adds users to the new SharePoint site.
String dwsCreateFolder(String url)
Creates a subfolder in the document library of the current Document Workspace site.
String dwsDeleteDws()
Deletes the current Document Workspace site and its contents.
String dwsDeleteFolder(String url)
Deletes a subfolder from a document library of the current Document Workspace site.
String dwsFindDwsDoc(String id)
Returns the absolute URL of a document listed in the documents parameter of a previous call to the CreateDws method.
String dwsGetDwsData(String document, String lastUpdate)
Returns information about a Document Workspace site and the lists it contains.
String dwsGetDwsMetaData(String document, String id, boolean minimal)
Returns information about a Document Workspace site and the lists it contains.
String dwsRemoveDwsUser(String id)
Removes the specified user from the list of users for the current Document Workspace site.
String dwsRenameDws(String title)
Changes the title of the current Document Workspace site.
String dwsUpdateDwsData(String updates, String meetingInstance)
Performs a batch update of items and data for the Document Workspace site.
RequestStatus emailChangeContactsMembershipInDistributionGroup(String alias, MailArrayOfString addListForContacts, MailArrayOfString deleteListForContacts, boolean deleteAllCurrentMembers)
Requests the addition and removal of contacts from the specified e-mail distribution group.
RequestStatus emailChangeUsersMembershipInDistributionGroup(String alias, MailArrayOfString addNt4NameList, MailArrayOfString deleteNt4NameList, boolean deleteAllCurrentMembers)
Requests the addition and removal of users from the specified e-mail distribution group.
RequestStatus emailCreateContact(String alias, String firstName, String lastName, String forwardingEmail, ContactFlags flags)
Requests the creation of a new contact from the specified name and data.
RequestResponse emailCreateDistributionGroup(String alias, String groupname, String description, String contactCN, RequestInfo info, DistributionGroupFlags flags)
Requests the creation of a new e-mail distribution list from the specified data.
RequestStatus emailDeleteContact(String alias)
Requests the deletion of a contact from the Active Directory container.
RequestResponse emailDeleteDistributionGroup(String alias, RequestInfo info)
Requests the deletion of an e-mail distribution group.
RequestResponse emailGetJobStatus(int jobId)
Requests an update on the status of a previous request that had PendingApproval status when it was last checked.
RequestStatus emailModifyContact(String oldAlias, String newAlias, String firstName, String lastName, String forwardingEmail, ContactFlags flags)
Requests a change in information about a contact.
RequestResponse emailModifyDistributionGroup(String alias, String groupname, String description, String contactCN, RequestInfo info, DistributionGroupFlags flags)
Requests a change in the stored information about an e-mail distribution group.
RequestResponse emailRenameDistributionGroup(String oldAlias, String newAlias, RequestInfo info)
Request a change in the alias for an e-mail distribution group.
GetFormResponse.GetFormResult formGetForm(String listName, String formUrl)
Returns the schema of a form for a specified list based on the name of the list and the URL of the form.
GetFormCollectionResponse.GetFormCollectionResult formGetFormCollection(String listName)
Returns the URLs and types of the forms for a list.
InputStream getFileAsStream(String url)
Returns the stream content of the file.
void groupAddGroup(String groupName, String ownerIdentifier, String ownerType, String defaultUserLoginName, String description)
Adds a group to the current site collection.
void groupAddGroupToRole(String roleName, String groupName)
Adds the specified group to the specified role definition.
void groupAddRole(String roleName, String description, int permissionMask)
Adds a role definition to the current site collection.
void groupAddRoleDef(String roleName, String description, BigInteger permissionMask)
Adds a role definition to the current site collection.
void groupAddUserCollectionToGroup(String groupName, AddUserCollectionToGroup.UsersInfoXml usersInfoXml)
Adds the collection of users to the specified group.
void groupAddUserCollectionToRole(String roleName, AddUserCollectionToRole.UsersInfoXml usersInfoXml)
Adds the collection of users to the specified role definition.
void groupAddUserToGroup(String groupName, String userName, String userLoginName, String userEmail, String userNotes)
Adds the user to the specified group.
void groupAddUserToRole(String roleName, String userName, String userLoginName, String userEmail, String userNotes)
Adds the user to the specified role definition.
GetAllUserCollectionFromWebResponse.GetAllUserCollectionFromWebResult groupGetAllUserCollectionFromWeb()
Returns information about the collection of users for the current Web site.
GetCurrentUserInfoResponse.GetCurrentUserInfoResult groupGetCurrentUserInfo()
Gets the current user info

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getcurrentuserinfo(v=office.14).aspx

GetGroupCollectionResponse.GetGroupCollectionResult groupGetGroupCollection(GetGroupCollection.GroupNamesXml groupNamesXml)
Returns information about the specified groups in the current site collection.
GetGroupCollectionFromRoleResponse.GetGroupCollectionFromRoleResult groupGetGroupCollectionFromRole(String roleName)
Returns information about the collection of groups assigned to the specified role definition.
GetGroupCollectionFromSiteResponse.GetGroupCollectionFromSiteResult groupGetGroupCollectionFromSite()
Removes the specified users from the current site collection.
GetGroupCollectionFromUserResponse.GetGroupCollectionFromUserResult groupGetGroupCollectionFromUser(String userLoginName)
Returns information about the collection of groups of which the specified user is a member.
GetGroupCollectionFromWebResponse.GetGroupCollectionFromWebResult groupGetGroupCollectionFromWeb()
Returns information about the collection of groups for the current Web site.
GetGroupInfoResponse.GetGroupInfoResult groupGetGroupInfo(String groupName)
Returns information about the specified group.
GetRoleCollectionResponse.GetRoleCollectionResult groupGetRoleCollection(GetRoleCollection.RoleNamesXml roleNamesXml)
Returns information about the specified collection of role definitions for the current Web site.
GetRoleCollectionFromGroupResponse.GetRoleCollectionFromGroupResult groupGetRoleCollectionFromGroup(String groupName)
Returns information about the collection of role definitions of which the specified group is a member.
GetRoleCollectionFromUserResponse.GetRoleCollectionFromUserResult groupGetRoleCollectionFromUser(String userLoginName)
Retrieves information about the collection of role definitions in which the specified user is a member.
GetRoleCollectionFromWebResponse.GetRoleCollectionFromWebResult groupGetRoleCollectionFromWeb()
Returns information about the collection of groups for the current Web site.
GetRoleInfoResponse.GetRoleInfoResult groupGetRoleInfo(String roleName)
Returns information about the specified role definition.
GetRolesAndPermissionsForCurrentUserResponse.GetRolesAndPermissionsForCurrentUserResult groupGetRolesAndPermissionsForCurrentUser()
Retrieves permissions and role definitions for the current user.
GetRolesAndPermissionsForSiteResponse.GetRolesAndPermissionsForSiteResult groupGetRolesAndPermissionsForSite()
Retrieves permissions and role definitions for the specified Web site.
GetUserCollectionResponse.GetUserCollectionResult groupGetUserCollection(GetUserCollection.UserLoginNamesXml userLoginNamesXml)
Returns information about a collection of users based on the specified user names.
GetUserCollectionFromGroupResponse.GetUserCollectionFromGroupResult groupGetUserCollectionFromGroup(String groupName)
Returns information about the collection of users in the specified group.
GetUserCollectionFromRoleResponse.GetUserCollectionFromRoleResult groupGetUserCollectionFromRole(String roleName)
Returns information about the collection of users assigned to the specified role definition.
GetUserCollectionFromSiteResponse.GetUserCollectionFromSiteResult groupGetUserCollectionFromSite()
Returns information about the collection of users for the current site collection.
GetUserCollectionFromWebResponse.GetUserCollectionFromWebResult groupGetUserCollectionFromWeb()
Returns information about the collection of users for the current Web site.
GetUserInfoResponse.GetUserInfoResult groupGetUserInfo(String userLoginName)
Returns information about the specified user.
GetUserLoginFromEmailResponse.GetUserLoginFromEmailResult groupGetUserLoginFromEmail(GetUserLoginFromEmail.EmailXml emailXml)
Returns a user name based on the specified e-mail address.
void groupRemoveGroup(String groupName)
Removes the specified group from the current site collection.
void groupRemoveGroupFromRole(String roleName, String groupName)
Removes the specified group from the specified role definition.
void groupRemoveRole(String roleName)
Removes the specified role definition from the current Web site.
void groupRemoveUserCollectionFromGroup(String groupName, RemoveUserCollectionFromGroup.UserLoginNamesXml userLoginNamesXml)
Removes the users with the specified user names from the group.
void groupRemoveUserCollectionFromRole(String roleName, RemoveUserCollectionFromRole.UserLoginNamesXml userLoginNamesXml)
Removes the users with the specified user names from the specified role definition.
void groupRemoveUserCollectionFromSite(RemoveUserCollectionFromSite.UserLoginNamesXml userLoginNamesXml)
Removes the specified users from the current site collection.
void groupRemoveUserFromGroup(String groupName, String userLoginName)
Removes the specified user from the specified group.
void groupRemoveUserFromRole(String roleName, String userLoginName)
Removes the specified user from the specified role definition.
void groupRemoveUserFromSite(String userLoginName)
Removes the specified user from the current site collection.
void groupRemoveUserFromWeb(String userLoginName)
Removes the specified user from the current Web site.
void groupUpdateGroupInfo(String oldGroupName, String groupName, String ownerIdentifier, String ownerType, String description)
Updates information for the specified group.
void groupUpdateRoleDefInfo(String oldRoleName, String roleName, String description, BigInteger permissionMask)
Updates information for the specified role definition.
void groupUpdateRoleInfo(String oldRoleName, String roleName, String description, int permissionMask)
Updates information for the specified role definition.
void groupUpdateUserInfo(String userLoginName, String userName, String userEmail, String userNotes)
Updates information for the specified user.
CheckSubwebAndListResponse.CheckSubwebAndListResult imagingCheckSubwebAndList(String strUrl)
Checks the specified URL and attempts to resolve it.
CreateNewFolderResponse.CreateNewFolderResult imagingCreateNewFolder(String strListName, String strParentFolder)
Creates a new folder with the name "New folder" in the specified list and folder.
DeleteResponse.DeleteResult imagingDelete(String strListName, String strFolder, ImagingArrayOfString itemFileNames)
Removes the specified files and folders (items) from the specified list on the current Web site.
DownloadResponse.DownloadResult imagingDownload(String strListName, String strFolder, ImagingArrayOfString itemFileNames, Long fileType, Boolean fFetchOriginalIfNotAvailable)
Downloads the specified files (items) in a list on the current Web site.
GetItemsByIdsResponse.GetItemsByIdsResult imagingGetItemsByIds(String strListName, ArrayOfUnsignedInt ids)
Returns the items with the specified IDs.
GetItemsXMLDataResponse.GetItemsXMLDataResult imagingGetItemsXmlData(String strListName, String strFolder, ImagingArrayOfString itemFileNames)
Returns the metadata of all items in the specified list on the current Web site.
GetListItemsResponse.GetListItemsResult imagingGetListItems(String strListName, String strFolder)
Returns the last modified date and other information about the items in a specified folder in a list on the current Web site.
ListPictureLibraryResponse.ListPictureLibraryResult imagingListPictureLibrary()
Lists all picture libraries on the current Web site.
RenameResponse.RenameResult imagingRename(String strListName, String strFolder, Rename.Request request)
Renames the specified files (items) in a list on the current Web site.
UploadResponse.UploadResult imagingUpload(String strListName, String strFolder, ByteArrayOutputStream bytes, String fileName, boolean fOverWriteIfExist)
Uploads a file to a list on the current Web site.
boolean isConnected()
Are we connected
String listAddAttachment(AddAttachment request)
Adds an attachment to the specified list item in the specified list.
void listAddDiscussionBoardItem(AddDiscussionBoardItem request)
Adds an item to the specified discussion board on the current Web site.
AddListResponse.AddListResult listAddList(AddList request)
Creates a list in the current site based on the specified name, description, and list template ID.
AddListFromFeatureResponse.AddListFromFeatureResult listAddListFromFeature(AddListFromFeature request)
Creates a list in the current site based on the specified name, description, Feature ID, and list template ID.
AddWikiPageResponse.AddWikiPageResult listAddWikiPage(AddWikiPage request)
Adds wiki page
boolean listCheckOutFile(CheckOutFile request)
Allows documents in a SharePoint document library to be checked out remotely.
String listCreateContentType(CreateContentType request)
Creates a list content type on the list.
void listDeleteAttachment(DeleteAttachment request)
Removes the attachment from the specified list item.
DeleteContentTypeResponse.DeleteContentTypeResult listDeleteContentType(DeleteContentType request)
Removes the specified list content type from the designated list.
DeleteContentTypeXmlDocumentResponse.DeleteContentTypeXmlDocumentResult listDeleteContentTypeXmlDocument(DeleteContentTypeXmlDocument request)
Removes the specified list content type xml document.
void listDeleteList(DeleteList request)
Deletes the specified list.
GetAttachmentCollectionResponse.GetAttachmentCollectionResult listGetAttachmentCollection(GetAttachmentCollection request)
Returns a list of the URLs for attachments to the specified item.
List<Object> listGetList(GetList request)
Returns a schema for the specified list.
GetListAndViewResponse.GetListAndViewResult listGetListAndView(GetListAndView request)
Returns the list and view schemas for the specified list
GetListCollectionResponse.GetListCollectionResult listGetListCollection()
Returns the names and GUIDs for all lists in the site.
GetListContentTypeResponse.GetListContentTypeResult listGetListContentType(GetListContentType request)
Returns the content type definition schema for the specified list content type.
GetListContentTypesResponse.GetListContentTypesResult listGetListContentTypes(GetListContentTypes request)
Returns a collection of content type definition schemas for all list content types on the given list.
GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult listGetListContentTypesAndProperties(GetListContentTypesAndProperties request)
Returns a collection of content types and properties for the given list
GetListItemChangesResponse.GetListItemChangesResult listGetListItemChanges(GetListItemChanges request)
Returns changes made to the list since the specified date and time.
GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult listGetListItemChangesSinceToken(GetListItemChangesSinceToken request)
Returns changes made to the list since the date and time specified in the token.
GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult listGetListItemChangesWithKnowledge(GetListItemChangesWithKnowledge request)
Returns all of the list items that meet specified criteria and that have changed since the date-time specified in the knowledge parameter for the specified list.
GetListItemsResponse.GetListItemsResult listGetListItems(GetListItems request)
Returns information about items in the list based on the specified query.
GetVersionCollectionResponse.GetVersionCollectionResult listGetVersionCollection(GetVersionCollection request)
Returns version information for the specified field in a SharePoint list.
boolean listListCheckInFile(CheckInFile request)
Allows documents to be checked in to a SharePoint document library remotely
boolean listUndoCheckOut(UndoCheckOut request)
Undoes the check-out of a given document in a SharePoint document library.
UpdateContentTypeResponse.UpdateContentTypeResult listUpdateContentType(UpdateContentType request)
Updates the specified list content type.
UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult listUpdateContentTypeXmlDocument(UpdateContentTypeXmlDocument request)
Adds or overwrites the specified XMLDocument element in the specified list content type.
UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult listUpdateContentTypesXmlDocument(UpdateContentTypesXmlDocument request)
Adds or overwrites the specified XMLDocument element for all content types on the specified list.
UpdateListResponse.UpdateListResult listUpdateList(UpdateList request)
Updates a list based on the specified field definitions and list properties.
UpdateListItemsResponse.UpdateListItemsResult listUpdateListItems(UpdateListItems request)
Adds, deletes, or updates the specified items in a list on the current site.
UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult listUpdateListItemsWithKnowledge(UpdateListItemsWithKnowledge request)
Makes inserts, updates, and deletions to specified list items and provides the server with current knowledge metadata.
AddMeetingResponse.AddMeetingResult meetingAddMeeting(String organizerEmail, String uid, long sequence, XMLGregorianCalendar utcDateStamp, String title, String location, XMLGregorianCalendar utcDateStart, XMLGregorianCalendar utcDateEnd, boolean nonGregorian)
Associates a meeting with the Meeting Workspace site on the specified server running Windows SharePoint Services.
AddMeetingFromICalResponse.AddMeetingFromICalResult meetingAddMeetingFromICal(String organizerEmail, String icalText)
Associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified server running Windows SharePoint Services.
CreateWorkspaceResponse.CreateWorkspaceResult meetingCreateWorkspace(String title, String templateName, long lcid, TimeZoneInf timeZoneInformation)
Creates a new Meeting Workspace subsite on the specified server running Windows SharePoint Services.
void meetingDeleteWorkspace()
Deletes the Meeting Workspace site from the specified server running Windows SharePoint Services.
GetMeetingWorkspacesResponse.GetMeetingWorkspacesResult meetingGetMeetingWorkspaces(boolean recurring)
Lists the Meeting Workspace sites located in the root directory of the specified server running Windows SharePoint Services at the specified site location.
GetMeetingsInformationResponse.GetMeetingsInformationResult meetingGetMeetingsInformation(long requestFlags, long lcid)
Lists the languages and templates supported by the specified server running Windows SharePoint Services.
void meetingRemoveMeeting(long recurrenceId, String uid, long sequence, XMLGregorianCalendar utcDateStamp, boolean cancelMeeting)
Removes the association between a meeting and a Meeting Workspace site.
void meetingRestoreMeeting(String uid)
Restores and relinks a meeting that was previously removed from a meeting instance.
void meetingSetAttendeeResponse(String attendeeEmail, long recurrenceId, String uid, long sequence, XMLGregorianCalendar utcDateTimeOrganizerCriticalChange, XMLGregorianCalendar utcDateTimeAttendeeCriticalChange, AttendeeResponse response)
Sets the attendee response for a meeting.
void meetingSetWorkspaceTitle(String title)
Sets the title of the Meeting Workspace site on the specified server running Windows SharePoint Services.
void meetingUpdateMeeting(String uid, long sequence, XMLGregorianCalendar utcDateStamp, String title, String location, XMLGregorianCalendar utcDateStart, XMLGregorianCalendar utcDateEnd, boolean nonGregorian)
Updates the meeting information on a Meeting Workspace site.
UpdateMeetingFromICalResponse.UpdateMeetingFromICalResult meetingUpdateMeetingFromICal(String icalText, boolean ignoreAttendees)
Updates meeting information stored in Internet Calendar (iCal) format.
boolean peopleIsClaimsMode()
Indicates if it is Claims mode

API link: http://msdn.microsoft.com/en-us/library/websvcpeople.people.isclaimsmode(v=office.14).aspx

ArrayOfPrincipalInfo peopleResolvePrincipals(PeopleArrayOfString principalKeys, List<String> principalType, boolean addToUserInfoList)
Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.
ArrayOfPrincipalInfo peopleSearchPrincipals(String searchText, int maxResults, List<String> principalType)
Returns an array of PrincipalInfo objects from the SPUserCollection for the Web site.
void permissionAddPermission(String objectName, String objectType, String permissionIdentifier, String permissionType, int permissionMask)
Modifies site-level permissions for the site group that exists on the site, or adds or modifies permissions to the specified list for the user, site group, or cross-site group that exists on the site.
void permissionAddPermissionCollection(String objectName, String objectType, AddPermissionCollection.PermissionsInfoXml permissionsInfoXml)
Modifies site-level permissions for the specified collection of existing site groups, or adds or modifies permissions to the list for the specified collection of existing users, site groups, and cross-site groups.
GetPermissionCollectionResponse.GetPermissionCollectionResult permissionGetPermissionCollection(String objectName, String objectType)
Returns the collection of permissions for a site or list.
void permissionRemovePermission(String objectName, String objectType, String permissionIdentifier, String permissionType)
Removes the specified permission from the list.
void permissionRemovePermissionCollection(String objectName, String objectType, RemovePermissionCollection.MemberIdsXml memberIdsXml)
Removes permissions from the list for the specified members.
void permissionUpdatePermission(String objectName, String objectType, String permissionIdentifier, String permissionType, int permissionMask)
Modifies site-level permissions for the specified site group, or modifies permissions to the list for the specified user, site group, or cross-site group.
String query(String queryXml)
Returns an XML string containing the search results set for the specified query.
void sitedataEnumerateFolder(String strFolderUrl, Holder<Long> enumerateFolderResult, Holder<ArrayOfSFPUrl> vUrls)
Returns information about the files and folders within a folder on a SharePoint site.
void sitedataGetAttachments(String strListName, String strItemId, Holder<Long> getAttachmentsResult, Holder<SitedataArrayOfString> vAttachments)
Returns the URLs for all attachments to a specified item in a SharePoint list.
void sitedataGetChanges(ObjectType objectType, String contentDatabaseId, Holder<String> startChangeId, Holder<String> endChangeId, int timeout, Holder<String> getChangesResult, Holder<Boolean> moreChanges)
Returns the changes that occurred on a site collection content from one moment in time to another.
void sitedataGetContent(ObjectType objectType, String objectId, String folderUrl, String itemId, boolean retrieveChildItems, boolean securityOnly, Holder<String> lastItemIdOnPage, Holder<String> getContentResult)
A string representing information about the web application.
void sitedataGetList(String strListName, Holder<Long> getListResult, Holder<SListMetadata> sListMetadata, Holder<ArrayOfSProperty> vProperties)
Returns metadata from the specified SharePoint list.
void sitedataGetListCollection(Holder<Long> getListCollectionResult, Holder<ArrayOfSList> vLists)
Returns information about all the lists in the current SharePoint site.
String sitedataGetListItems(String strListName, String strQuery, String strViewFields, long uRowLimit)
Performs a query against the specified SharePoint list.
void sitedataGetSite(Holder<Long> getSiteResult, Holder<SSiteMetadata> sSiteMetadata, Holder<ArrayOfSWebWithTime> vWebs, Holder<String> strUsers, Holder<String> strGroups, Holder<SitedataArrayOfString> vGroups)
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.
void sitedataGetSiteAndWeb(String strUrl, Holder<Long> getSiteAndWebResult, Holder<String> strSite, Holder<String> strWeb)
Returns the absolute URL of a subsite and the absolute URL of its top-level parent site based on the specified site URL.
void sitedataGetSiteUrl(String url, Holder<Long> getSiteUrlResult, Holder<String> siteUrl, Holder<String> siteId)
Returns the GUID and URL of the site collection to which the specified URL belongs.
void sitedataGetUrlSegments(String strURL, Holder<Boolean> getURLSegmentsResult, Holder<String> strWebID, Holder<String> strBucketID, Holder<String> strListID, Holder<String> strItemID)
A string representing the identifiers of a site, list or list item depending on the specified URL.
void sitedataGetWeb(Holder<Long> getWebResult, Holder<SWebMetadata> sWebMetadata, Holder<ArrayOfSWebWithTime> vWebs, Holder<ArrayOfSListWithTime> vLists, Holder<ArrayOfSFPUrl> vFPUrls, Holder<String> strRoles, Holder<SitedataArrayOfString> vRolesUsers, Holder<SitedataArrayOfString> vRolesGroups)
Returns site and list metadata, as well as information about the users and site groups for the current SharePoint site.
String sitesCreateWeb(String url, String title, String description, String templateName, Long language, Long locale, Long collationLocale, Boolean uniquePermissions, Boolean anonymous, Boolean presence)
Create Web

API link: http://msdn.microsoft.com/en-us/library/ee658286(v=office.14).aspx

void sitesDeleteWeb(String url)
Delete web

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.deleteweb(v=office.14).aspx

String sitesExportSolution(String solutionFileName, String title, String description, boolean fullReuseExportMode, boolean includeWebContent)
Export Solution

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.exportsolution(v=office.14).aspx

int sitesExportWeb(String jobName, String webUrl, String dataPath, boolean includeSubwebs, boolean includeUserSecurity, boolean overWrite, int cabSize)
Exports a Web site.
String sitesGetSite(String siteUrl)
Get Site

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getsite(v=office.14).aspx

void sitesGetSiteTemplates(long lcid, Holder<Long> getSiteTemplatesResult, Holder<ArrayOfTemplate> templateList)
Returns information about the collection of site definitions and sites templates in the Web application.
String sitesGetUpdatedFormDigest()
Get Updated From Digest

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx

FormDigestInformation sitesGetUpdatedFormDigestInformation(String url)
Get Updated Form Digest Information

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx

int sitesImportWeb(String jobName, String webUrl, SitesArrayOfString dataFiles, String logPath, boolean includeUserSecurity, boolean overWrite)
Import web

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.importweb(v=office.14).aspx

DeleteAllVersionsResponse.DeleteAllVersionsResult versionsDeleteAllVersions(String fileName)
Deletes all versions of the specified file.
DeleteVersionResponse.DeleteVersionResult versionsDeleteVersion(String fileName, String fileVersion)
Deletes the specified file version.
void versionsDeleteView(String listName, String viewName)
Deletes the specified view of the specified list.
GetVersionsResponse.GetVersionsResult versionsGetVersions(String fileName)
Returns information about the versions of the specified file.
RestoreVersionResponse.RestoreVersionResult versionsRestoreVersion(String fileName, String fileVersion)
Restores the specified file version.
AddViewResponse.AddViewResult viewsAddView(String listName, String viewName, AddView.ViewFields viewFields, AddView.Query query, AddView.RowLimit rowLimit, String type, boolean makeViewDefault)
Creates a view for the specified list.
GetViewResponse.GetViewResult viewsGetView(String listName, String viewName)
Returns the schema of the specified view for the specified list.
GetViewCollectionResponse.GetViewCollectionResult viewsGetViewCollection(String listName)
Returns the display names, internal names, and URLs for the collection of views of the specified list.
GetViewHtmlResponse.GetViewHtmlResult viewsGetViewHtml(String listName, String viewName)
Returns the full schema of the specified view for the specified list, including the HTML sections.
UpdateViewResponse.UpdateViewResult viewsUpdateView(String listName, String viewName, UpdateView.ViewProperties viewProperties, UpdateView.Query query, UpdateView.ViewFields viewFields, UpdateView.Aggregations aggregations, UpdateView.Formats formats, UpdateView.RowLimit rowLimit)
Modifies the specified view of the specified list.
UpdateViewHtmlResponse.UpdateViewHtmlResult viewsUpdateViewHtml(String listName, String viewName, UpdateViewHtml.ViewProperties viewProperties, UpdateViewHtml.Toolbar toolbar, UpdateViewHtml.ViewHeader viewHeader, UpdateViewHtml.ViewBody viewBody, UpdateViewHtml.ViewFooter viewFooter, UpdateViewHtml.ViewEmpty viewEmpty, UpdateViewHtml.RowLimitExceeded rowLimitExceeded, UpdateViewHtml.Query query, UpdateViewHtml.ViewFields viewFields, UpdateViewHtml.Aggregations aggregations, UpdateViewHtml.Formats formats, UpdateViewHtml.RowLimit rowLimit)
Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.
UpdateViewHtml2Response.UpdateViewHtml2Result viewsUpdateViewHtml2(String listName, String viewName, UpdateViewHtml2.ViewProperties viewProperties, UpdateViewHtml2.Toolbar toolbar, UpdateViewHtml2.ViewHeader viewHeader, UpdateViewHtml2.ViewBody viewBody, UpdateViewHtml2.ViewFooter viewFooter, UpdateViewHtml2.ViewEmpty viewEmpty, UpdateViewHtml2.RowLimitExceeded rowLimitExceeded, UpdateViewHtml2.Query query, UpdateViewHtml2.ViewFields viewFields, UpdateViewHtml2.Aggregations aggregations, UpdateViewHtml2.Formats formats, UpdateViewHtml2.RowLimit rowLimit, String openApplicationExtension)
Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.
String webpartAddWebPart(String pageUrl, String webPartXml, Storage storage)
Adds a new Web Part to a Web Part Page.
String webpartAddWebPartToZone(String pageUrl, String webPartXml, Storage storage, String zoneId, int zoneIndex)
Add Web Part To Zone

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.addwebparttozone(v=office.14).aspx

String webpartAssociateWorkflowMarkup(String configUrl, String configVersion)
Creates a new SPWorkflowAssociation object list applied in the /WorkflowConfig/Association/@ListID attribute in the associated configuration file.
String webpartConvertWebPartFormat(String inputFormat, FormatConversionOption formatConversionOption)
Convert Web Part Format

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.convertwebpartformat(v=office.14).aspx

void webpartDeleteWebPart(String pageUrl, String storageKey, Storage storage)
Deletes a dynamic Web Part from a Web Part Page.
String webpartExecuteProxyUpdates(String updateData)
Execute Proxy Updates

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.executeproxyupdates(v=office.14).aspx

String webpartFetchLegalWorkflowActions()
Returns a string version of the actions file, as defined by the Actions File Schema

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.fetchlegalworkflowactions(v=office.14).aspx

String webpartGetAssemblyMetaData(String assemblyName, String baseTypes)
Get Assembly Metadata

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getassemblymetadata(v=office.14).aspx

String webpartGetBindingResourceData(String resourceName)
Get Binding Resource Data

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getbindingresourcedata(v=office.14).aspx

GetCustomControlListResponse.GetCustomControlListResult webpartGetCustomControlList()
Get Custom Control List

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getcustomcontrollist(v=office.14).aspx

String webpartGetDataFromDataSourceControl(String dscXml, String contextUrl)
Get Data From Data Source Control

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getdatafromdatasourcecontrol(v=office.14).aspx

String webpartGetExpandedListViewXml(String webId, String listViewXml, String listGuid, String listUrl, String listDisplayName, Boolean hasConnection, Boolean partialView)
Get Expanded List View Xml

API link: http://msdn.microsoft.com/en-us/library/ee658354(v=office.14).aspx

String webpartGetFormCapabilityFromDataSourceControl(String dscXml)
Get Form Capability From Data Source Control

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getformcapabilityfromdatasourcecontrol(v=office.14).aspx

GetSafeAssemblyInfoResponse.GetSafeAssemblyInfoResult webpartGetSafeAssemblyInfo()
Get Safe Assembly Info

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getsafeassemblyinfo(v=office.14).aspx

String webpartGetWebPart(String pageurl, String storageKey, Storage storage)
Returns the XML data for a dynamic Web Part.
String webpartGetWebPart2(String pageurl, String storageKey, Storage storage, SPWebServiceBehavior behavior)
Returns the XML data for a dynamic Web Part.
String webpartGetWebPartCrossPageCompatibility(String sourcePageUrl, String sourcePageContents, String targetPageUrl, String targetPageContents, String providerPartID, String lcid)
Returns connection information for all parts on the target page and compatibility information of the source Web Part with all the parts on a target page, which is used to determine whether Web Parts on two different pages are compatible with each other.
String webpartGetWebPartPage(String documentName, SPWebServiceBehavior behavior)
Get Web Part Page

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpage(v=office.14).aspx

String webpartGetWebPartPageConnectionInfo(String sourcePageUrl, String sourcePageContents, String providerPartID, String lcid)
Returns connection information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page.
String webpartGetWebPartPageDocument(String documentName)
Returns the Web Part Page, complete with the Web Parts and the properties included within each Web Part zone.
GetWebPartPropertiesResponse.GetWebPartPropertiesResult webpartGetWebPartProperties(String pageUrl, Storage storage)
Returns an XML string of all Web Parts associated with a Web Part Page.
GetWebPartProperties2Response.GetWebPartProperties2Result webpartGetWebPartProperties2(String pageUrl, Storage storage, SPWebServiceBehavior behavior)
Returns an XML string of all Web Parts associated with a Web Part Page.
String webpartGetXmlDataFromDataSource(String queryXml)
Returns XML data from the data source provider.
String webpartRemoveWorkflowAssociation(String configUrl, String configVersion)
Removes all SPWorkflowAssociation objects on the list defined by the /WorkflowConfig/Association/@ListID value in the configuration file.
String webpartRenderWebPartForEdit(String webPartXml)
Returns an XML fragment that includes the Web Part property information and the rendering HTML.
void webpartSaveWebPart(String pageUrl, String storageKey, String webPartXml, Storage storage)
Saves changes to an existing dynamic Web Part.
void webpartSaveWebPart2(String pageUrl, String storageKey, String webPartXml, Storage storage, boolean allowTypeChange)
Saves changes to an existing dynamic Web Part, including a change to the Web Part type.
String webpartValidateWorkflowMarkupAndCreateSupportObjects(String workflowMarkupText, String rulesText, String configBlob, String flag)
Creates a workflow task list, if one is not specified, or if the specified task list does not exist in the context Web site; also updates content types on the task list.
String websCreateContentType(String displayName, String parentType, CreateContentType.NewFields newFields, CreateContentType.ContentTypeProperties contentTypeProperties)
Creates a new site content type, with the specified columns and properties, on the site.
void websCustomizeCss(String cssFile)
Applies style sheet customization to a particular file.
DeleteContentTypeResponse.DeleteContentTypeResult websDeleteContentType(String contentTypeId)
Deletes the specified site content type from the site.
String websGetActivatedFeatures()
Returns a list of Features that are activated in the Web site and in its parent site collection.
GetAllSubWebCollectionResponse.GetAllSubWebCollectionResult websGetAllSubWebCollection()
Returns the titles and URLs of all sites within the current site collection.
GetColumnsResponse.GetColumnsResult websGetColumns()
Returns a collection of the column definitions for the columns available on the site.
GetContentTypeResponse.GetContentTypeResult websGetContentType(String contentTypeId)
Returns the content type definition for the specified site content type.
GetContentTypesResponse.GetContentTypesResult websGetContentTypes()
Returns a collection of content type definitions for all site content types on the specified site.
CustomizedPageStatus websGetCustomizedPageStatus(String fileUrl)
Gets the customization (also known as "ghosted") status of the file with the specified URL.
GetListTemplatesResponse.GetListTemplatesResult websGetListTemplates()
Returns the collection of list template definitions for the current site.
GetObjectIdFromUrlResponse.GetObjectIdFromUrlResult websGetObjectIdFromUrl(String objectUrl)
Get Object Id From Url

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getobjectidfromurl(v=office.14).aspx

GetWebResponse.GetWebResult websGetWeb(String webUrl)
Returns properties of a site (for example, name, description, and theme).
GetWebCollectionResponse.GetWebCollectionResult websGetWebCollection()
Returns the titles and URLs of all sites directly beneath the current site.
RemoveContentTypeXmlDocumentResponse.RemoveContentTypeXmlDocumentResult websRemoveContentTypeXmlDocument(String contentTypeId, String documentUri)
Removes the specified XmlDocument Element (ContentType) element from the specified site content type.
void websRevertAllFileContentStreams()
Reverts the content streams of all files within the Web site.
void websRevertCss(String cssFile)
Reverts style sheet customization of a file to the default style sheet.
void websRevertFileContentStream(String fileUrl)
Reverts the content stream of the file with the specified URL.
UpdateColumnsResponse.UpdateColumnsResult websUpdateColumns(UpdateColumns.NewFields newFields, UpdateColumns.UpdateFields updateFields, UpdateColumns.DeleteFields deleteFields)
Creates, updates, or deletes one or more columns on the specified site.
UpdateContentTypeResponse.UpdateContentTypeResult websUpdateContentType(String contentTypeId, UpdateContentType.ContentTypeProperties contentTypeProperties, UpdateContentType.NewFields newFields, UpdateContentType.UpdateFields updateFields, UpdateContentType.DeleteFields deleteFields)
Updates the specified site content type.
UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult websUpdateContentTypeXmlDocument(String contentTypeId, UpdateContentTypeXmlDocument.NewDocument newDocument)
Adds or overwrites the specified XmlDocument Element (ContentType) element in the site content type.
String websWebUrlFromPageUrl(String pageUrl)
Returns the URL of the parent site for the specified page URL.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private Client client

private boolean connected

private Object connectedLock

private JerseyUtil jerseyUtil

private SharepointAlertsClient sharepointAlertClient

private SharepointAuthenticationClient sharepointAuthenticationClient

private SharepointCopyClient sharepointCopyClient

private SharepointDwsClient sharepointDwsClient

private SharepointEmailClient sharepointEmailClient

private SharepointFormsClient sharepointFormClient

private SharepointImagingClient sharepointImagingClient

private SharepointListClient sharepointListClient

private SharepointMeetingsClient sharepointMeetingsClient

private SharepointPeopleClient sharepointPeopleClient

private SharepointPermissionsClient sharepointPermissionsClient

private SharepointQueryClient sharepointQueryClient

private SharepointSiteDataClient sharepointSiteDataClient

private SharepointSitesClient sharepointSitesClient

private SharepointUserGroupClient sharepointUserGroupClient

private SharepointVersionsClient sharepointVersionsClient

private SharepointViewsClient sharepointViewsClient

private SharepointWebPartPagesClient sharepointWebPartPagesClient

private SharepointWebsClient sharepointWebsClient

Public Constructors

public SharepointConnector ()

Public Methods

public ArrayOfDeleteFailure alertDeleteAlerts (AlertArrayOfString iDs)

Deletes the specified alerts within a Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcalerts.alerts.deletealerts(v=office.14).aspx

Parameters
iDs A string array that contains the GUIDs of alerts to delete.
Returns
  • A DeleteFailure array that contains the alert ID and error status of unsuccessful deletions.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public AlertInfo alertGetAlerts ()

Returns information about the alerts within a Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcalerts.alerts.getalerts(v=office.14).aspx

Returns
  • An AlertInfo structure whose fields contain information about each alert, as well as the URL of the page for managing alerts on the site, the name of the server, the type of site definition used to create the site (for example, STS), the URL of the site, the GUID identifying the site, the title of the site, the display name of the current user, and the URL of the page used for choosing a list or document library when creating an alert through the My Alerts on this Site page.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public LoginResult authLogin (String user, String pass)

Used in a forms-based authentication system to either set an authentication cookie or, if there is a problem with the logon, return an error code.

API link: http://msdn.microsoft.com/en-us/library/websvcauthentication.authentication.login(v=office.14).aspx

Parameters
user The user's logon name for the SharePoint site.
pass The user's password.
Returns
  • A LoginResult structure that contains either an error code in its ErrorCode field or the name of an authentication cookie in its CookieName property.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public AuthenticationMode authMode ()

Returns the authentication mode for the current SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcauthentication.authentication.mode(v=office.14).aspx

Returns
  • An @{link AuthenticationMode} that identifies the user authentication system that is being used by the current SharePoint site.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void connect (String username, String password, String serverUrl)

Connect to the Sharepoint service

Parameters
username Username
password Password
serverUrl Server url
Throws
ConnectionException

public String connectionId ()

Are we connected

public void copyCopyIntoItems (String sourceUrl, DestinationUrlCollection destinationUrls, FieldInformationCollection fields, ByteArrayOutputStream stream, Holder<Long> copyIntoItemsResult, Holder<CopyResultCollection> results)

Copies a document represented by a Byte array to one or more locations on a server.

API link: http://msdn.microsoft.com/en-us/library/websvccopy.copy.copyintoitems(v=office.14).aspx

Parameters
sourceUrl A String that contains the absolute source URL of the document to be copied.
destinationUrls An array of Strings that contain one or more absolute URLs specifying the destination location or locations of the copied document.
fields An array of FieldInformation objects that define and optionally assign values to one or more fields associated with the copied document.
stream An array of Bytes that contain the document to copy using base-64 encoding.
copyIntoItemsResult A UInt32 that returns 0 to indicate that the operation has completed.
results An array of CopyResult objects, passed as an out parameter.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void copyCopyIntoItemsLocal (String sourceUrl, DestinationUrlCollection destinationUrls, Holder<Long> copyIntoItemsLocalResult, Holder<CopyResultCollection> results)

Copies a document from one location on a server running Microsoft SharePoint Foundation to another location on the same server.

API link: http://msdn.microsoft.com/en-us/library/websvccopy.copy.copyintoitemslocal(v=office.14).aspx

Parameters
sourceUrl A String that contains the absolute source URL of the document to be copied.
destinationUrls An array of Strings that contain one or more absolute URLs specifying the destination location or locations of the copied document.
copyIntoItemsLocalResult A UInt32 that returns 0 to indicate that the operation has completed.
results An array of CopyResult objects, passed as an out parameter.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void copyGetItem (String url, Holder<Long> getItemResult, Holder<FieldInformationCollection> fields, Holder<byte[]> stream)

Generates a Byte array representation of a document that can be passed to the CopyIntoItems method to copy the document to a different server.

API link: http://msdn.microsoft.com/en-us/library/websvccopy.copy.getitem(v=office.14).aspx

Parameters
url A String that contains the absolute source (on the server to which the SOAP request is sent) of the document that is to be retrieved.
getItemResult A UInt32 that returns 0 to indicate that the operation has completed.
fields An array of FieldInformation objects, passed as an out parameter, that represent the fields and the corresponding field values that can be copied from the retrieved document.
stream An array of Bytes, passed as an out parameter, that is a base-64 representation of the retrieved document's binary data.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void disconnect ()

Disconnect

public String dwsCanCreateDwsUrl (String url)

Determines whether the user has sufficient rights to create a Document Workspace site with the proposed URL on the server.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.cancreatedwsurl(v=office.14).aspx

Parameters
url The proposed URL for the new Document Workspace site.
Returns
  • A string that returns the URL in the format proposed URL when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsCreateDws (String documentUrl, String users, String title, String documents)

Creates a Document Workspace site and optionally adds users to the new SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.createdws(v=office.14).aspx

Parameters
documentUrl The optional URL of the new Document Workspace site. If an empty string is passed, the URL of the new SharePoint site is based on the title, with illegal characters removed or replaced with underscores and with (n) appended if needed to make the URL unique.
users An optional list of users to add to the new SharePoint site, in the following format: <UserInfo><item Email="{email address of user" Name="{display name of user}"/> }
title The title of the new Document Workspace site.
documents An optional list of documents for Microsoft Windows SharePoint Services to retain for subsequent calls to the FindDwsDoc method. Used by Microsoft Office Outlook when adding shared attachments to a new Document Workspace site. This list is returned in the following format: <Documents><item ID="{document ID" Name="{document name}"/> }
Returns
  • The string that the CreateDws method returns results in the following format when successful. <Results> <Url>{url of the Document Workspace site {url of the document library in the Document Workspace site} {title of the Document Workspace site ... }
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsCreateFolder (String url)

Creates a subfolder in the document library of the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.createfolder(v=office.14).aspx

Parameters
url The proposed site-based URL of the folder to create; for example, "Shared Documents/folder_name".
Returns
  • A string that returns an empty tag when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsDeleteDws ()

Deletes the current Document Workspace site and its contents.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.deletedws(v=office.14).aspx

Returns
  • A string that returns an empty tag when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsDeleteFolder (String url)

Deletes a subfolder from a document library of the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.deletefolder(v=office.14).aspx

Parameters
url The site-based URL of the folder to delete; for example, "Shared Documents/folder_name."
Returns
  • A string that returns an empty tag when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsFindDwsDoc (String id)

Returns the absolute URL of a document listed in the documents parameter of a previous call to the CreateDws method.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.finddwsdoc(v=office.14).aspx

Parameters
id The globally unique identifier (GUID) used to identify the document. This GUID is stored as a part of the _SharedFileIndex custom property for the document.
Returns
  • A string that returns the absolute URL of the document in the format document url when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsGetDwsData (String document, String lastUpdate)

Returns information about a Document Workspace site and the lists it contains.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.getdwsdata(v=office.14).aspx

Parameters
document The site-based URL of a document in a document library in the Document Workspace site; for example, "Shared Documents/document_name.doc." This argument provides context for the Documents list returned by the GetDwsData method.
lastUpdate The LastUpdate value returned in the results of a previous call to the GetDwsData or GetDwsMetadata method, or an empty string. If a list in the Document Workspace site has not changed since lastUpdate, the GetDwsData method returns "no changes" in place of list data for performance reasons.
Returns
  • A string that is an XML document fragment that contains the following information:
    • Title
    • LastUpdate
    • User
    • Members
    • Assignees
    • Lists (Tasks, Documents, Links)
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsGetDwsMetaData (String document, String id, boolean minimal)

Returns information about a Document Workspace site and the lists it contains.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.getdwsmetadata(v=office.14).aspx

Parameters
document The site-based URL of a document in a document library in the Document Workspace site; for example, "Shared Documents/document_name.doc." This argument provides context for the document information returned by the GetDwsMetaData method.
id An optional document globally unique identifier (GUID). The id argument is used by Microsoft Office Outlook to retrieve the full document URL when a user opens a shared attachment.
minimal Determines whether the output includes information about the schemas, lists, documents, links, and tasks lists of a Document Workspace site.
Returns
  • A string that is an XML document fragment that contains the following information:
    • SubscribeUrl
    • MtgInstance (meeting instance, if applicable)
    • SettingsUrl (site settings URL)
    • PermsUrl (edit permissions url)
    • UserInfoUrl (user information url)
    • Roles
    • [Schema items] (if Minimal is FALSE)
    • [ListInfo items] (if Minimal is FALSE)
    • Permissions
    • HasUniquePerm (true/false)
    • WorkspaceType ("DWS", "MWS", "SPS", "")
    • IsADMode (true/false)
    • DocUrl
    • Minimal (true/false)
    • Results (data returned by the GetDwsData method)
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsRemoveDwsUser (String id)

Removes the specified user from the list of users for the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.removedwsuser(v=office.14).aspx

Parameters
id The ID of the user to remove from the list of users.
Returns
  • A string that returns an empty tag when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsRenameDws (String title)

Changes the title of the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.renamedws(v=office.14).aspx

Parameters
title The new title for the Document Workspace site.
Returns
  • A string that returns an empty tag when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String dwsUpdateDwsData (String updates, String meetingInstance)

Performs a batch update of items and data for the Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.updatedwsdata(v=office.14).aspx

Parameters
updates The list of item updates, in Collaborative Application Markup Language (CAML) batch update format. For example, use the following batch update to save a new task in the task list of the Document Workspace site. <?xml version="1.0" encoding="UTF-8"?> <ows:Batch OnError="Continue" xmlns:ows="http://tempuri.org/"> <SetVar Name="DatesInGregorian">TRUE</SetVar> <SetVar Name="TimesInUTC">TRUE</SetVar> <Method ID="New"> <SetList Scope="Request">{EA448C91-16D4-411E-AC42-7BA092641E60 Save New Test 1 Not Started (2) Normal 2003-02-11T16:00:00Z <div>This is the description.</div> }
meetingInstance Optional instance of a recurring meeting. The meetingInstance parameter applies to the entire batch update and specifies the meeting instance to which the UpdateDwsData method adds new list items.
Returns
  • A string that returns an empty tag when successful.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestStatus emailChangeContactsMembershipInDistributionGroup (String alias, MailArrayOfString addListForContacts, MailArrayOfString deleteListForContacts, boolean deleteAllCurrentMembers)

Requests the addition and removal of contacts from the specified e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.changecontactsmembershipindistributiongroup(v=office.14).aspx

Parameters
alias The name of the distribution group.
addListForContacts The aliases of the contacts that are added to the group.
deleteListForContacts The aliases of the contacts that are removed from the group.
deleteAllCurrentMembers A value indicating whether all members are removed from the group before the contacts in AddListForContacts are added.
Returns
  • A RequestStatus value that reports the outcome of the operation.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestStatus emailChangeUsersMembershipInDistributionGroup (String alias, MailArrayOfString addNt4NameList, MailArrayOfString deleteNt4NameList, boolean deleteAllCurrentMembers)

Requests the addition and removal of users from the specified e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.changeusersmembershipindistributiongroup(v=office.14).aspx

Parameters
alias The name of the distribution group.
addNt4NameList The users that are added to the group.
deleteNt4NameList The users that are removed from the group.
deleteAllCurrentMembers A value indicating whether all members are removed from the group before the users in AddNt4NameList are added.
Returns
  • A RequestStatus value that reports the outcome of the operation.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestStatus emailCreateContact (String alias, String firstName, String lastName, String forwardingEmail, ContactFlags flags)

Requests the creation of a new contact from the specified name and data.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.createcontact(v=office.14).aspx

Parameters
alias The e-mail alias for the contact.
firstName The first name of the contact.
lastName The last name of the contact.
forwardingEmail The e-mail address of the contact.
flags A value indicating whether unauthenticated e-mail that is addressed to the contact is deleted by Microsoft Exchange or sent to the contact.
Returns
  • A RequestStatus value that reports the outcome of the operation.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestResponse emailCreateDistributionGroup (String alias, String groupname, String description, String contactCN, RequestInfo info, DistributionGroupFlags flags)

Requests the creation of a new e-mail distribution list from the specified data.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.createdistributiongroup(v=office.14).aspx

Parameters
alias The e-mail alias of the group.
groupname The user-friendly name of the group.
description A description of the group.
contactCN The manager of the group, who is added as a member.
info An object containing information about the person who wants to create the group and his or her reasons.
flags A value indicating whether unauthenticated e-mail that is addressed to the group is deleted by Microsoft Exchange or sent to the group.
Returns
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestStatus emailDeleteContact (String alias)

Requests the deletion of a contact from the Active Directory container.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.deletecontact(v=office.14).aspx

Parameters
alias The e-mail alias of the contact that is deleted.
Returns
  • A RequestStatus value that reports the outcome of the operation.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestResponse emailDeleteDistributionGroup (String alias, RequestInfo info)

Requests the deletion of an e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.deletedistributiongroup(v=office.14).aspx

Parameters
alias The e-mail alias of the distribution list that
info An object containing information about the person who wants to delete the group and his or her reasons.
Returns
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestResponse emailGetJobStatus (int jobId)

Requests an update on the status of a previous request that had PendingApproval status when it was last checked.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.getjobstatus(v=office.14).aspx

Parameters
jobId The ID returned in the RequestResponse object by the original request.
Returns
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestStatus emailModifyContact (String oldAlias, String newAlias, String firstName, String lastName, String forwardingEmail, ContactFlags flags)

Requests a change in information about a contact.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.modifycontact(v=office.14).aspx

Parameters
oldAlias The current e-mail alias of the contact.
newAlias The e-mail alias that the contact is to have hereafter. It can be the same as OldAlias.
firstName The first name of the contact.
lastName The last name of the contact.
forwardingEmail The e-mail address of the contact.
flags A value indicating whether unauthenticated e-mail that is addressed to the contact is deleted by Microsoft Exchange or sent to the contact.
Returns
  • A RequestStatus value that reports the outcome of the operation.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestResponse emailModifyDistributionGroup (String alias, String groupname, String description, String contactCN, RequestInfo info, DistributionGroupFlags flags)

Requests a change in the stored information about an e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.modifydistributiongroup(v=office.14).aspx

Parameters
alias The e-mail alias of the group.
groupname The user-friendly name of the group. (This can be the same as the existing value or changed.)
description A description of the group. (This can be the same as the existing value or changed.)
contactCN The manager of the group. (This can be the same as the existing value or changed.)
info An object containing information about the person who wants to change the information about the group and his or her reasons.
flags A value indicating whether unauthenticated e-mail that is addressed to the group is deleted by Microsoft Exchange or sent to the group. (This can be the same as the existing value or changed.)
Returns
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RequestResponse emailRenameDistributionGroup (String oldAlias, String newAlias, RequestInfo info)

Request a change in the alias for an e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.renamedistributiongroup(v=office.14).aspx

Parameters
oldAlias The current e-mail alias of the group.
newAlias The e-mail alias that the group is to have hereafter.
info An object containing information about the person who wants to change the alias of the group and his or her reasons.
Returns
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetFormResponse.GetFormResult formGetForm (String listName, String formUrl)

Returns the schema of a form for a specified list based on the name of the list and the URL of the form.

API link: http://msdn.microsoft.com/en-us/library/websvcforms.forms.getform(v=office.14).aspx

Parameters
listName String that contains the internal name of the list.
formUrl String that contains the site-relative URL of the form to retrieve (for example, Lists/List_Name/NewForm.aspx).
Returns
  • An XML fragment in the following form that contains the URL, type, and Web Part zone ID for the form
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetFormCollectionResponse.GetFormCollectionResult formGetFormCollection (String listName)

Returns the URLs and types of the forms for a list.

API link: http://msdn.microsoft.com/en-us/library/websvcforms.forms.getformcollection(v=office.14).aspx

Parameters
listName String that contains the internal name of the list.
Returns
  • An XML fragment in the following form that contains the URL and type for the form
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public InputStream getFileAsStream (String url)

Returns the stream content of the file.

Parameters
url The absolute url of the file. Example: http://mydomain.subdomain.com/listName/itemName.itemExtension
Returns
  • the stream content of the file

public void groupAddGroup (String groupName, String ownerIdentifier, String ownerType, String defaultUserLoginName, String description)

Adds a group to the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addgroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the new group.
ownerIdentifier A string that contains the user name (DOMAIN\User_Alias) of the owner for the group.
ownerType A string that specifies the type of owner, which can be either user or group.
defaultUserLoginName A string that contains the user name (DOMAIN\User_Alias) of the default user for the group.
description A string that contains a description of the group.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddGroupToRole (String roleName, String groupName)

Adds the specified group to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addgrouptorole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
groupName A string that contains the name of the group.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddRole (String roleName, String description, int permissionMask)

Adds a role definition to the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addrole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
description A string that contains the description for the role definition.
permissionMask A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies permissions for the new role definition.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddRoleDef (String roleName, String description, BigInteger permissionMask)

Adds a role definition to the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addroledef(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
description A string that contains the description for the role definition.
permissionMask A 64-bit unsigned integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies permissions for the new role definition
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddUserCollectionToGroup (String groupName, AddUserCollectionToGroup.UsersInfoXml usersInfoXml)

Adds the collection of users to the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusercollectiontogroup(v=office.14).aspx

Parameters
groupName The name of the group to add users to.
usersInfoXml Object that contains information about the users in the following form 
<Users>
<User LoginName="Domain\User1_Alias" Email="User1_E-mail" Name="User1_Display_Name" Notes="Notes"/>
<User LoginName="Domain\User2_Alias" Email="User2_E-mail" Name="User2_Display_Name" Notes="Notes"/>
</Users>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddUserCollectionToRole (String roleName, AddUserCollectionToRole.UsersInfoXml usersInfoXml)

Adds the collection of users to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusercollectiontorole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition to add users to.
usersInfoXml A System.Xml.XmlNode object that contains information about the users to add in the following form: 

<Users>
  <User LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Name="User1_Display_Name" Notes="Notes"/>
  <User LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Name="User2_Display_Name" Notes="Notes"/>
</Users>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddUserToGroup (String groupName, String userName, String userLoginName, String userEmail, String userNotes)

Adds the user to the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusertogroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the group.
userName A string that contains the display name of the user.
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
userEmail A string that contains the e-mail address of the user.
userNotes A string that contains notes for the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupAddUserToRole (String roleName, String userName, String userLoginName, String userEmail, String userNotes)

Adds the user to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusertorole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
userName A string that contains the display name of the user.
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user
userEmail A string that contains the e-mail address of the user.
userNotes A string that contains notes for the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetAllUserCollectionFromWebResponse.GetAllUserCollectionFromWebResult groupGetAllUserCollectionFromWeb ()

Returns information about the collection of users for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getallusercollectionfromweb(v=office.14).aspx

Returns
  • An XML fragment in the following form 
    <GetAllUserCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="9" Sid="S-1-5-21-2127521184-1604012920-1887927527-207153" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="10" Sid="S-1-5-21-2127521184-1604012920-1887927527-4270" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetAllUserCollectionFromWeb>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetCurrentUserInfoResponse.GetCurrentUserInfoResult groupGetCurrentUserInfo ()

Gets the current user info

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getcurrentuserinfo(v=office.14).aspx

Returns
  • The current user info
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetGroupCollectionResponse.GetGroupCollectionResult groupGetGroupCollection (GetGroupCollection.GroupNamesXml groupNamesXml)

Returns information about the specified groups in the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollection(v=office.14).aspx

Parameters
groupNamesXml Object that specifies one or more group names in the following form: 
<Groups>
  <Group GroupName="Group1"/>
  <Group GroupName="Group2"/>
</Groups>
Returns
  • An XML fragment in the following form 
    <GetGroupCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
<Groups>
<Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
<Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
</Groups>
</GetGroupCollection>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetGroupCollectionFromRoleResponse.GetGroupCollectionFromRoleResult groupGetGroupCollectionFromRole (String roleName)

Returns information about the collection of groups assigned to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollectionfromrole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
Returns
  • An XML fragment in the following form 
    <GetGroupCollectionFromRole xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Groups>
    <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Group ID="16" Name="Group3" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Groups>
</GetGroupCollectionFromRole>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetGroupCollectionFromSiteResponse.GetGroupCollectionFromSiteResult groupGetGroupCollectionFromSite ()

Removes the specified users from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromsite(v=office.14).aspx

Returns
  • object that contains the user names (DOMAIN\User_Alias) of the users in the following form 
    <Users>
<User LoginName="Domain\User1_Alias"/>
<User LoginName="Domain\User2_Alias"/>
</Users>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetGroupCollectionFromUserResponse.GetGroupCollectionFromUserResult groupGetGroupCollectionFromUser (String userLoginName)

Returns information about the collection of groups of which the specified user is a member.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollectionfromuser(v=office.14).aspx

Parameters
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
Returns
  • An XML fragment in the following form 
    <GetGroupCollectionFromUser xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Groups>
    <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Group ID="16" Name="Group3" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Groups>
</GetGroupCollectionFromUser>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetGroupCollectionFromWebResponse.GetGroupCollectionFromWebResult groupGetGroupCollectionFromWeb ()

Returns information about the collection of groups for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollectionfromweb(v=office.14).aspx

Returns
  • An XML fragment in the following form 
    <GetGroupCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Groups>
    <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Group ID="16" Name="Group3" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Groups>
</GetGroupCollectionFromWeb>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetGroupInfoResponse.GetGroupInfoResult groupGetGroupInfo (String groupName)

Returns information about the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupinfo(v=office.14).aspx

Parameters
groupName A string that contains the name of the group.
Returns
  • An XML fragment in the following form 
    <GetGroupInfo xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
</GetGroupInfo>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRoleCollectionResponse.GetRoleCollectionResult groupGetRoleCollection (GetRoleCollection.RoleNamesXml roleNamesXml)

Returns information about the specified collection of role definitions for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollection(v=office.14).aspx

Parameters
roleNamesXml Object that specifies one or more role definition names in the following form 
<Roles>
  <Role RoleName="Site_Group1"/>
  <Role RoleName="Site_Group2"/>
</Roles>
Returns
  • An XML fragment in the following form that can be assigned to a System.Xml.XmlNode object. 
    <GetRoleCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Roles>
    <Role ID="1073741830" Name="Site_Group1" Description="Description" Type="0" />
    <Role ID="1073741831" Name="Site_Group2" Description="Description" Type="0" />
  </Roles>
</GetRoleCollection>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRoleCollectionFromGroupResponse.GetRoleCollectionFromGroupResult groupGetRoleCollectionFromGroup (String groupName)

Returns information about the collection of role definitions of which the specified group is a member.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollectionfromgroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the group.
Returns
  • An XML fragment in the following form 
    <GetRoleCollectionFromGroup xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Roles>
    <Role ID="1073741830" Name="Site_Group1" Description="Description" Type="0" />
    <Role ID="1073741833" Name="Site_Group2" Description="Description" Type="0" />
 </Roles>
</GetRoleCollectionFromGroup>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRoleCollectionFromUserResponse.GetRoleCollectionFromUserResult groupGetRoleCollectionFromUser (String userLoginName)

Retrieves information about the collection of role definitions in which the specified user is a member.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollectionfromuser(v=office.14).aspx

Parameters
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
Returns
  • Returns an XML fragment that provides information about the specified collection of role definitions.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRoleCollectionFromWebResponse.GetRoleCollectionFromWebResult groupGetRoleCollectionFromWeb ()

Returns information about the collection of groups for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollectionfromweb(v=office.14).aspx

Returns
  • An XML fragment in the following form 
    <GetRoleCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Roles>
    <Role ID="1073741825" Name="Guest" Description="Can view specific lists or document libraries when given permissions." Type="1" />
    <Role ID="1073741826" Name="Reader" Description="Has read-only access to the Web site." Type="2" />
    <Role ID="1073741827" Name="Contributor" Description="Can add content to existing document libraries and lists." Type="3" />
    <Role ID="1073741828" Name="Web Designer" Description="Can create lists and document libraries and customize pages in the Web site." Type="4" />
    <Role ID="1073741829" Name="Administrator" Description="Has full  control of the Web site." Type="5" />
    <Role ID="3" Name="Group6" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Role ID="15" Name="Group7" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Role ID="16" Name="Group8" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Roles>
</GetRoleCollectionFromWeb>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRoleInfoResponse.GetRoleInfoResult groupGetRoleInfo (String roleName)

Returns information about the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getroleinfo(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
Returns
  • An XML fragment in the following form 
    <GetRoleInfo xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Role ID="1073741830" Name="Role_Definition" Description="Description" Type="0" />
</GetRoleInfo>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRolesAndPermissionsForCurrentUserResponse.GetRolesAndPermissionsForCurrentUserResult groupGetRolesAndPermissionsForCurrentUser ()

Retrieves permissions and role definitions for the current user. API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolesandpermissionsforcurrentuser(v=office.14).aspx

Returns
  • Returns an XML fragment that provides permissions and role definition information for the current user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetRolesAndPermissionsForSiteResponse.GetRolesAndPermissionsForSiteResult groupGetRolesAndPermissionsForSite ()

Retrieves permissions and role definitions for the specified Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolesandpermissionsforsite(v=office.14).aspx

Returns
  • Returns an XML fragment that provides permissions and role definition information for the specified Web site.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserCollectionResponse.GetUserCollectionResult groupGetUserCollection (GetUserCollection.UserLoginNamesXml userLoginNamesXml)

Returns information about a collection of users based on the specified user names.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollection(v=office.14).aspx

Parameters
userLoginNamesXml Object that contains information about the users in the following form 
<Users>
  <User LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Name="User1_Display_Name" Notes="Notes"/>
  <User LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Name="User2_Display_Name" Notes="Notes"/>
</Users>
Returns
  • An XML fragment in the following form 
    <GetUserCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollection>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserCollectionFromGroupResponse.GetUserCollectionFromGroupResult groupGetUserCollectionFromGroup (String groupName)

Returns information about the collection of users in the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromgroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the cross-site group.
Returns
  • An XML fragment in the following form 
    <GetUserCollectionFromGroup xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollectionFromGroup>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserCollectionFromRoleResponse.GetUserCollectionFromRoleResult groupGetUserCollectionFromRole (String roleName)

Returns information about the collection of users assigned to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromrole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
Returns
  • An XML fragment in the following form 
    <GetUserCollectionFromRole xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
   <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollectionFromRole>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserCollectionFromSiteResponse.GetUserCollectionFromSiteResult groupGetUserCollectionFromSite ()

Returns information about the collection of users for the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromsite(v=office.14).aspx

Returns
  • An XML fragment in the following form 
     <GetUserCollectionFromSite xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
   </Users>
</GetUserCollectionFromSite>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserCollectionFromWebResponse.GetUserCollectionFromWebResult groupGetUserCollectionFromWeb ()

Returns information about the collection of users for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromweb(v=office.14).aspx

Returns
  • An XML fragment in the following form 
    <GetUserCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollectionFromWeb>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserInfoResponse.GetUserInfoResult groupGetUserInfo (String userLoginName)

Returns information about the specified user.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getuserinfo(v=office.14).aspx

Parameters
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
Returns
  • An XML fragment in the following form 
    <GetUserInfo xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
<User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
</GetUserInfo>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetUserLoginFromEmailResponse.GetUserLoginFromEmailResult groupGetUserLoginFromEmail (GetUserLoginFromEmail.EmailXml emailXml)

Returns a user name based on the specified e-mail address.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getuserloginfromemail(v=office.14).aspx

Parameters
emailXml Object that specifies the e-mail address of the user.
Returns
  • An XML fragment in the following form that specifies the user name (DOMAIN\User_Alias) and other information in the following form 
    <GetUserLoginFromEmail xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <User Login="DOMAIN\User1_Alias" Email="User1_Email" DisplayName="User1_Display" SiteUser="0"></User>
  <User Login="DOMAIN\User2_Alias" Email="User2_Email" DisplayName="User2_Display" SiteUser="1"></User>
</GetUserLoginFromEmail>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveGroup (String groupName)

Removes the specified group from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removegroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the group.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveGroupFromRole (String roleName, String groupName)

Removes the specified group from the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removegroupfromrole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
groupName A string that contains the name of the group.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveRole (String roleName)

Removes the specified role definition from the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removerole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserCollectionFromGroup (String groupName, RemoveUserCollectionFromGroup.UserLoginNamesXml userLoginNamesXml)

Removes the users with the specified user names from the group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromgroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the group.
userLoginNamesXml Object that contains the user names (DOMAIN\User_Alias) of the users in the following form
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserCollectionFromRole (String roleName, RemoveUserCollectionFromRole.UserLoginNamesXml userLoginNamesXml)

Removes the users with the specified user names from the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromrole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
userLoginNamesXml Object that contains the user names (DOMAIN\User_Alias) of the users in the following form 
<Users>
<User LoginName="Domain\User1_Alias"/>
<User LoginName="Domain\User2_Alias"/>
</Users>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserCollectionFromSite (RemoveUserCollectionFromSite.UserLoginNamesXml userLoginNamesXml)

Removes the specified users from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromsite(v=office.14).aspx

Parameters
userLoginNamesXml A System.Xml.XmlNode object that contains the user names (DOMAIN\User_Alias) of the users in the following form: 

<Users>
  <User LoginName="Domain\User1_Alias">
  <User LoginName="Domain\User2_Alias">
</Users>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserFromGroup (String groupName, String userLoginName)

Removes the specified user from the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromgroup(v=office.14).aspx

Parameters
groupName A string that contains the name of the group.
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserFromRole (String roleName, String userLoginName)

Removes the specified user from the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromrole(v=office.14).aspx

Parameters
roleName A string that contains the name of the role definition.
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserFromSite (String userLoginName)

Removes the specified user from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromsite(v=office.14).aspx

Parameters
userLoginName A string that contains the user name (DOMAIN\User_Alias) of the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupRemoveUserFromWeb (String userLoginName)

Removes the specified user from the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromweb(v=office.14).aspx

Parameters
userLoginName String that contains the user name (DOMAIN\User_Alias) of the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupUpdateGroupInfo (String oldGroupName, String groupName, String ownerIdentifier, String ownerType, String description)

Updates information for the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updategroupinfo(v=office.14).aspx

Parameters
oldGroupName A string that contains the old name of the group.
groupName A string that contains the new name of the group.
ownerIdentifier A string that contains the user name (DOMAIN\User_Alias) for the owner of the group.
ownerType A string that specifies the type of owner, which can be either user or group.
description A string that contains the description for the group.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupUpdateRoleDefInfo (String oldRoleName, String roleName, String description, BigInteger permissionMask)

Updates information for the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updateroledefinfo(v=office.14).aspx

Parameters
oldRoleName A string that contains the old name of the role definition.
roleName A string that contains the name of the role definition.
description A string that contains the description for the role definition.
permissionMask A 64-bit unsigned integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies permissions for the new role definition.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupUpdateRoleInfo (String oldRoleName, String roleName, String description, int permissionMask)

Updates information for the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updateroleinfo(v=office.14).aspx

Parameters
oldRoleName A string that contains the old name of the role definition.
roleName A string that contains the new name of the role definition.
description A string that contains a description of the role definition.
permissionMask A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies new permissions for the site group
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void groupUpdateUserInfo (String userLoginName, String userName, String userEmail, String userNotes)

Updates information for the specified user.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updateuserinfo(v=office.14).aspx

Parameters
userLoginName A string that specifies the user name (DOMAIN\User_Alias) of the user whose information is updated.
userName A string that contains the display name of the user.
userEmail A string that contains the e-mail address of the user.
userNotes A string that contains notes for the user.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public CheckSubwebAndListResponse.CheckSubwebAndListResult imagingCheckSubwebAndList (String strUrl)

Checks the specified URL and attempts to resolve it.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.checksubwebandlist(v=office.14).aspx

Parameters
strUrl The URL to analyze.
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the resolved URL. For example, if the strUrl parameter is http://MyServer/t1/forms/allitems.aspx
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public CreateNewFolderResponse.CreateNewFolderResult imagingCreateNewFolder (String strListName, String strParentFolder)

Creates a new folder with the name "New folder" in the specified list and folder. If a folder named "New folder" already exists in the specified folder, the CreateNewFolder method tries to create "New folder(1)", "New folder(2)", and so on.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.createnewfolder(v=office.14).aspx

Parameters
strListName The name of the list within the current site
strParentFolder The relative path from the root of the list to the parent folder
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public DeleteResponse.DeleteResult imagingDelete (String strListName, String strFolder, ImagingArrayOfString itemFileNames)

Removes the specified files and folders (items) from the specified list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.delete(v=office.14).aspx

Parameters
strListName The name of the list in the current site.
strFolder The relative path from the root of the list to the target folder.
itemFileNames An array of the name of files and folders (items) to be deleted from the list.
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. . . .
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public DownloadResponse.DownloadResult imagingDownload (String strListName, String strFolder, ImagingArrayOfString itemFileNames, Long fileType, Boolean fFetchOriginalIfNotAvailable)

Downloads the specified files (items) in a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.download(v=office.14).aspx

Parameters
strListName The name of the list within the current Web site.
strFolder The relative path from the root of the list to the target folder.
itemFileNames An array of the names of files (items) to download.
fileType The version of the files to download. Valid values: 0 for original, 1 for thumbnail, 2 for Web image.
fFetchOriginalIfNotAvailable If this parameter is set to true and the requested version is not available for any reason, the original version is fetched.
Returns
  • A System.Xml.XmlDocument object that contains the following. <Files xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <File name="itemFileNames[0]" found="false"/> <File name="itemFileNames[1]" lastmodified="…"> Base64 encoded bytes of the file content </File> <File name="itemFileNames[2]" lastmodified="…" originalDownloaded="true"> Base64 encoded bytes of the file content </File> . . . </Files>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetItemsByIdsResponse.GetItemsByIdsResult imagingGetItemsByIds (String strListName, ArrayOfUnsignedInt ids)

Returns the items with the specified IDs.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.getitemsbyids(v=office.14).aspx

Parameters
strListName The name of the list on the current Web site.
ids The IDs of the items to return.
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. <Library name="strListName " xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <z:row xmlns:z="#RowsetSchema" ows_ID="1" ows_Created="2002-05-02 19:41:36" ows_Author="1;#User_Alias" ows_Modified="2002-05-02 19:41:36" ows_Editor="1;#User_Alias" ows__ModerationStatus="0" ows_FileRef="1;#t1/55VGXIE6.jpg" ows_Last_x0020_Modified="1;#2002-05-02 19:41:36" ows_Created_x0020_Date="1;#2002-05-02 19:41:36" ows_File_x0020_Size="1;#30917" ows_FSObjType="1;#0" ows_CheckoutExpires="1;#" ows_CheckedOutUserId="1;#" ows_FileLeafRef="1;#55VGXIE6.jpg" ows_VirusStatus="1;#30917" ows_CheckedOutTitle="1;#" ows_Modified_x0020_By="DOMAIN\User_Alias" ows_owshiddenversion="0" ows_File_x0020_Type="jpg" ows_LinkFilenameNoMenu="55VGXIE6.jpg" ows_LinkFilename="55VGXIE6.jpg" ows_DocIcon="jpg" ows_ServerUrl="/t1/55VGXIE6.jpg" ows_EncodedAbsUrl="http://Server_Name/t1/55VGXIE6.jpg" ows_BaseName="55VGXIE6" ows_FileSizeDisplay="30917" ows_LinkSharing= "<a href="http://Server_Name/_layouts/1033/ShrOpt.aspx? obj=,document,{5DE3F393-52CF-4644-BA74-FF868C120A05"> ["Has Unique Perms" column value]" ows_ImageWidth="736" ows_ImageHeight="467" ows_ThumbnailUrl="http://Server_Name/t1/_t/55VGXIE6_jpg.jpg" ows_WebImgUrl="http://Server_Name/t1/_w/55VGXIE6_jpg.jpg" ows_NameOrTitle="jpg" ows_SelectedFlag="0" ows_ImageSize="736" ows_RequiredField="t1/55VGXIE6.jpg" /> . . . }
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetItemsXMLDataResponse.GetItemsXMLDataResult imagingGetItemsXmlData (String strListName, String strFolder, ImagingArrayOfString itemFileNames)

Returns the metadata of all items in the specified list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.getitemsxmldata(v=office.14).aspx

Parameters
strListName The name of the list within the current Web site.
strFolder The relative path from the root of the list to the target folder.
itemFileNames An array of the names of the files (items) for which you need the data.
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. <results xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <result item="filename1" lastmodified="true"/> <result item="filename2" found="false"/> . . . </results>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetListItemsResponse.GetListItemsResult imagingGetListItems (String strListName, String strFolder)

Returns the last modified date and other information about the items in a specified folder in a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.getlistitems(v=office.14).aspx

Parameters
strListName The name of the list within the current Web site.
strFolder The relative path from the root of the list to the target folder.
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. <Library name="strListName " xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <z:row xmlns:z="#RowsetSchema" ows_ID="1" ows_Created="2002-05-02 19:41:36" ows_Author="1;#User_Alias" ows_Modified="2002-05-02 19:41:36" ows_Editor="1;#User_Alias" ows__ModerationStatus="0" ows_FileRef="1;#t1/55VGXIE6.jpg" ows_Last_x0020_Modified="1;#2002-05-02 19:41:36" ows_Created_x0020_Date="1;#2002-05-02 19:41:36" ows_File_x0020_Size="1;#30917" ows_FSObjType="1;#0" ows_CheckoutExpires="1;#" ows_CheckedOutUserId="1;#" ows_FileLeafRef="1;#55VGXIE6.jpg" ows_VirusStatus="1;#30917" ows_CheckedOutTitle="1;#" ows_Modified_x0020_By="Domain\User_Name" ows_owshiddenversion="0" ows_File_x0020_Type="jpg" ows_LinkFilenameNoMenu="55VGXIE6.jpg" ows_LinkFilename="55VGXIE6.jpg" ows_DocIcon="jpg" ows_ServerUrl="/t1/55VGXIE6.jpg" ows_EncodedAbsUrl="http://Server_Name/t1/55VGXIE6.jpg" ows_BaseName="55VGXIE6" ows_FileSizeDisplay="30917" ows_LinkSharing="<a href= "http://Server_Name/_layouts/1033/ShrOpt.aspx? obj=,document,{5DE3F393-52CF-4644-BA74-FF868C120A05"> ["Has Unique Perms" column value]" ows_ImageWidth="736" ows_ImageHeight="467" ows_ThumbnailUrl="http:/ Server_Name/t1/_t/55VGXIE6_jpg.jpg" ows_WebImgUrl="http://Server_Name/t1/_w/55VGXIE6_jpg.jpg" ows_NameOrTitle="jpg" ows_SelectedFlag="0" ows_ImageSize="736" ows_RequiredField="t1/55VGXIE6.jpg" /> . . . }
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public ListPictureLibraryResponse.ListPictureLibraryResult imagingListPictureLibrary ()

Lists all picture libraries on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.listpicturelibrary(v=office.14).aspx

Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. . . .
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public RenameResponse.RenameResult imagingRename (String strListName, String strFolder, Rename.Request request)

Renames the specified files (items) in a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.rename(v=office.14).aspx

Parameters
strListName The name of the list within the current Web site.
strFolder The relative path from the root of the list to the target folder.
request The files to rename and the new base name. For example, to rename "tree.jpg" to "forest.jpg"
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. <results xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <result name="oldFileName0" renamed="true" newbasename="newBaseName0"/> <result name="oldFileName1ThatDoesNotExist" renamed="false"/> . . . </results>
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public UploadResponse.UploadResult imagingUpload (String strListName, String strFolder, ByteArrayOutputStream bytes, String fileName, boolean fOverWriteIfExist)

Uploads a file to a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.upload(v=office.14).aspx

Parameters
strListName The name of the list on the current Web site.
strFolder The relative path from the root of the list to the target folder.
bytes The binary content in the file to upload.
fileName The file name to use as item name in the list.
fOverWriteIfExist A Boolean value that indicates whether to overwrite a file with the same name. A FileExists exception is thrown if the item exists and fOverWriteIfExist is not true.
Returns
  • A Microsoft.SharePoint.SoapServer.SoapXml object that returns the last modified date of the item if the operation succeeds.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public boolean isConnected ()

Are we connected

public String listAddAttachment (AddAttachment request)

Adds an attachment to the specified list item in the specified list.

Parameters
request Object containing attachment information:

listName: string that contains either the title or the GUID for the list.

listItemId: string that contains the ID of the item to which attachments are added. This value does not correspond to the index of the item within the collection of list items.

fileName: string that contains the name of the file to add as an attachment.

attachment: byte array that contains the file to attach by using base-64 encoding.
Returns
  • A string that contains the URL for the attachment, which can subsequently be used to reference the attachment.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void listAddDiscussionBoardItem (AddDiscussionBoardItem request)

Adds an item to the specified discussion board on the current Web site.

Parameters
request Object containing discussion board information:

listName: string that contains either the title or the GUID for the list.

message: The base64Binary content of the item to add.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public AddListResponse.AddListResult listAddList (AddList request)

Creates a list in the current site based on the specified name, description, and list template ID.

Parameters
request Object containing list information:

listName: string that contains the title of the list.

description: string that contains a description for the list.

templateId: A 32-bit integer that specifies the list template to use. The following table shows possible values for the ID:

Announcements: 104

Contacts: 105

Custom List: 100

Custom List in DataSheet view: 120

DataSources: 110

Discussion Board: 108

Document Library: 101

Events: 106

Form Library: 115

Issues: 1100

Links: 103

Picture Library: 109

Survey: 102

Tasks: 107
Returns
  • The result list
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public AddListFromFeatureResponse.AddListFromFeatureResult listAddListFromFeature (AddListFromFeature request)

Creates a list in the current site based on the specified name, description, Feature ID, and list template ID.

Parameters
request Object containing list information:

listName: string that contains the title of the list.

description: string that contains a description for the list.

featureId: A System.Guid specifying the Feature ID.

templateId: A 32-bit integer that specifies the list template to use. The following table shows possible values for the ID:

Announcements: 104

Contacts: 105

Custom List: 100

Custom List in DataSheet view: 120

DataSources: 110

Discussion Board: 108

Document Library: 101

Events: 106

Form Library: 115

Issues: 1100

Links: 103

Picture Library: 109

Survey: 102

Tasks: 107
Returns
  • The result list
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public AddWikiPageResponse.AddWikiPageResult listAddWikiPage (AddWikiPage request)

Adds wiki page

Parameters
request Object containing wiki page information:

listName, ListRelPageUrl and wikiContent
Returns
  • The result list
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public boolean listCheckOutFile (CheckOutFile request)

Allows documents in a SharePoint document library to be checked out remotely.

Parameters
request Object containing check-out file information:

pageUrl: A string that contains the full path to the document to be checked out.

checkoutToLocal: A string containing "true" or "false" that designates whether the file is to be flagged as checked out for offline editing.

lastModified: A string in RFC 1123 date format representing the date and time of the last modification to the file; for example, "20 Jun 1982 12:00:00 GMT".
Returns
  • true-false
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public String listCreateContentType (CreateContentType request)

Creates a list content type on the list.

Parameters
request Object containing content type information:

listName: string containing the name of the list on which to create the content type.

displayName: string that represents the display name of the list content type.

parentType: string that contains the content type ID of the site content type on which to base the list content type.

fields: A string representing the collection of columns to include on the new site content type. Format the column collection as a FieldRefs element, where each FieldRef child element represents a reference to an existing column to include on the content type.

contentTypeProperties: A string representing the properties to specify for the content type. Format the properties as a ContentType element, and include the element attributes for the properties you want to specify.

addToView: string containing "true" or "false" that designates whether to add the content type to the list view.
Returns
  • String
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void listDeleteAttachment (DeleteAttachment request)

Removes the attachment from the specified list item.

Parameters
request Object containing delete attachment information:

listName: string that contains either the title or GUID for the list.

listItemId: string that contains the ID of the item to delete. This value does not correspond to the index of the item within the collection of list items.

url: string that contains the absolute URL for the attachment, as follows: http://Server_Name/Site_Name/Lists/List_Name/Attachments/Item_ID/FileName.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public DeleteContentTypeResponse.DeleteContentTypeResult listDeleteContentType (DeleteContentType request)

Removes the specified list content type from the designated list.

Parameters
request Object containing delete content type information:

listName: string that contains the name of the list from which to delete the content type.

contentTypeId: string containing the content type ID of the list content type to delete.
Returns
  • DeleteContentTypeResult
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public DeleteContentTypeXmlDocumentResponse.DeleteContentTypeXmlDocumentResult listDeleteContentTypeXmlDocument (DeleteContentTypeXmlDocument request)

Removes the specified list content type xml document.

Parameters
request Object containing delete content type xml document information:

listName, contentTypeId and documentUri
Returns
  • The result list
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public void listDeleteList (DeleteList request)

Deletes the specified list.

Parameters
request Object containing delete list information:

listName: string that contains either the title or the GUID for the list.
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public GetAttachmentCollectionResponse.GetAttachmentCollectionResult listGetAttachmentCollection (GetAttachmentCollection request)

Returns a list of the URLs for attachments to the specified item.

Parameters
request Object containing attachment collection request:

listName: string that contains either the title or the GUID for the list.

listItemId: string that contains the ID for the list item. This value does not correspond to the index of the item within the collection of list items.
Returns
  • GetAttachmentCollectionResponse.GetAttachmentCollectionResult
Throws
SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

public List<Object> listGetList (GetList request)

Returns a schema for the specified list.

Parameters
request Object containing list request:

listName: string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains "UserInfo".
Returns
  • List
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListAndViewResponse.GetListAndViewResult listGetListAndView (GetListAndView request)

    Returns the list and view schemas for the specified list

    Parameters
    request Object containing list and view request:

    listName: string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains "UserInfo".

    viewName: string that contains the GUID for the view. If no value is specified, returns the default view schema for the list.
    Returns
    • GetListAndViewResponse.GetListAndViewResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListCollectionResponse.GetListCollectionResult listGetListCollection ()

    Returns the names and GUIDs for all lists in the site.

    Returns
    • GetListCollectionResponse.GetListCollectionResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListContentTypeResponse.GetListContentTypeResult listGetListContentType (GetListContentType request)

    Returns the content type definition schema for the specified list content type.

    Parameters
    request Object containing list content type request:

    listName: string representing the name of the list that contains the list content type.

    contentTypeId: string containing the content type ID of the list content type.
    Returns
    • GetListContentTypeResponse.GetListContentTypeResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListContentTypesResponse.GetListContentTypesResult listGetListContentTypes (GetListContentTypes request)

    Returns a collection of content type definition schemas for all list content types on the given list.

    Parameters
    request Object containing list content types request:

    listName: string that represents the name of the list on which the content types are located.

    contentTypeId: string that represents the content type ID of the content type.
    Returns
    • GetListContentTypesResponse.GetListContentTypesResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult listGetListContentTypesAndProperties (GetListContentTypesAndProperties request)

    Returns a collection of content types and properties for the given list

    Parameters
    request Object containing list content type and properties request
    Returns
    • GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListItemChangesResponse.GetListItemChangesResult listGetListItemChanges (GetListItemChanges request)

    Returns changes made to the list since the specified date and time.

    Parameters
    request Object containing item changes request

    listName: string that contains either the title or GUID for the list. When querying the UserInfo table, the string contains "UserInfo".

    viewFields: ViewFields element that specifies which fields to return in the query and in what order.

    since: string that contains the date and time in Coordinated Universal Time (UTC) ISO8601 format from which to start retrieving changes in the list. The value of this parameter is typically retrieved from a prior SOAP response. If this value is null, the query returns all items in the list.

    contains: Contains element that defines custom filtering for the query.
    Returns
    • GetListItemChangesResponse.GetListItemChangesResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult listGetListItemChangesSinceToken (GetListItemChangesSinceToken request)

    Returns changes made to the list since the date and time specified in the token.

    Parameters
    request Object containing list item changes request

    listName: string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains UserInfo. Using the GUID results in better performance.

    viewName: string that contains the GUID for the view, which determines the view to use for the default view attributes represented by the query, viewFields, and rowLimit parameters. If this argument is not supplied, the default view is assumed. If it is supplied, the value of the query, viewFields, or rowLimit parameter overrides the equivalent setting within the view. For example, if the view specified by the viewFields parameter has a row limit of 100 rows but the rowLimit parameter contains 1000, then 1,000 rows are returned in the response.

    query: Query element containing the query that determines which records are returned and in what order.

    viewFields: specifies which fields to return in the query and in what order. If supplied, the value of this parameter overrides the view fields within the view specified by the viewName parameter or the view fields in the default view for the list. If this value is null, the query returns all fields for each item returned.

    rowLimit: string that specifies the number of items, or rows, to display on a page before paging begins. If supplied, the value of this parameter overrides the row limit set in the view specified by the viewName parameter or the row limit set in the default view for the list.

    queryOptions: options for the specific query. The doc is available here

    changeToken: string that contains the change token for the request. For description about its format please check Overview: Change Tokens, Object Types, and Change Types

    contains: element that defines custom filtering for the query.
    Returns
    • GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult listGetListItemChangesWithKnowledge (GetListItemChangesWithKnowledge request)

    Returns all of the list items that meet specified criteria and that have changed since the date-time specified in the knowledge parameter for the specified list.

    Parameters
    request Object containing list item changes with knowledge request

    listName: The GUID or the list title of the list from which to retrieve list items. If the specified list is the user information list, the string is set to "UserInfo" or "User Information list".

    viewName: The GUID of the view of the list from which to return list items. If not specified, the default list view is used. viewFields, rowLimit, and queryOptions parameters, if specified, must override corresponding attributes of the view used. Note that clients should not use this parameter. If specified, the server must ignore this parameter if the viewFields parameter is also specified; otherwise, the server must only validate that this parameter is both a valid GUID and that the parameter refers to a view of the list.

    query: Query to determine which records from the list are to be returned and the order in which they will be returned.

    viewFields: Specifies which fields of the list item should be returned. If not specified, whether by excluding the parameter or by including a null value, the fields defined for the viewName parameter view are used. If the Properties attribute of the ViewFields structure is set to true and the MetaInfo field is referenced in a FieldRef parameter, then properties related to the list must be returned with the prefix "ows_MetaInfo_".

    rowLimit: Specifies the maximum number of rows of data to return in the response. If not specified, whether by passing an empty element or by excluding the element, the default row limit for the view specified by the viewName parameter is used. Otherwise, this must be a 32-bit unsigned integer. The server must not return more list items than specified by this parameter.

    queryOptions: Specifies options that are available to modify the query.

    syncScope: Specifies the scope of the synchronization. If null, the default sync scope is used with an empty identifier.

    knowledge: Specifies the Microsoft Sync Framework knowledge data structure in XML format. If not provided by the client, all items in the list are returned, subject to the default row limit of the view or the overriding rowLimit parameter. If specified, the response will include changes made to list items after the knowledge was retrieved, subject to the row limit restrictions.

    contains: Restricts the results returned by giving a specific value to be searched for in the specified list item field. The server returns only those list items satisfying this criteria.
    Returns
    • GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListItemsResponse.GetListItemsResult listGetListItems (GetListItems request)

    Returns information about items in the list based on the specified query.

    Parameters
    request Object containing list item changes with knowledge request

    listName: tring that contains either the display name or the GUID for the list. It is recommended that you use the GUID, which must be surrounded by curly braces ({}). When querying the UserInfo table, the string contains "UserInfo".

    viewName: string that contains the GUID for the view surrounded by curly braces ({}), which determines the view to use for the default view attributes represented by the query, viewFields, and rowLimit parameters. If this parameter contains an empty string, the default view is used. If the view GUID is supplied, the value of the query, viewFields, or rowLimit parameter overrides the equivalent setting within the view. For example, if the view specified by the viewFields parameter has a row limit of 100 rows but the rowLimit parameter contains 1000, then 1,000 rows are returned in the response.

    query: element containing the query that determines which records are returned and in what order. If supplied, the value of this parameter overrides either the query within the view specified by the viewName parameter or the query within the default view for the list.

    viewFields: element that specifies which fields to return in the query and in what order. If supplied, the value of this parameter overrides the view fields within the view specified by the viewName parameter or the view fields in the default view for the list.

    rowLimit: specifies the number of items, or rows, to display on a page before paging begins. If supplied, the value of this parameter overrides the row limit set in the view specified by the viewName parameter or the row limit set in the default view for the list.

    queryOptions: options for the specific query. The doc is available here

    webId: string containing the GUID of the parent Web site for the list surrounded by curly braces ({}). Setting this parameter to null means the Web site specified by the Url property of the service will be used, and if the Url property of the service is not specified, the root Web site will be used.
    Returns
    • GetListItemsResponse.GetListItemsResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetVersionCollectionResponse.GetVersionCollectionResult listGetVersionCollection (GetVersionCollection request)

    Returns version information for the specified field in a SharePoint list.

    Parameters
    request Object containing version collection request

    listId: string that contains the ID of the list.

    listItemId: string that contains the ID of the item.

    fieldName: string that contains the name of the field.
    Returns
    • GetVersionCollectionResponse.GetVersionCollectionResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public boolean listListCheckInFile (CheckInFile request)

    Allows documents to be checked in to a SharePoint document library remotely

    Parameters
    request Object containing check-in file information:

    pageUrl: string that contains the full path to the document to check in.

    comment: string containing optional check-in comments.

    checkInType: A string representation of the values 0, 1 or 2, where 0 = MinorCheckIn, 1 = MajorCheckIn, and 2 = OverwriteCheckIn.
    Returns
    • true-false
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public boolean listUndoCheckOut (UndoCheckOut request)

    Undoes the check-out of a given document in a SharePoint document library.

    Parameters
    request Object containing undo checkout request

    pageUrl: string that contains the full path to the document.
    Returns
    • boolean
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateContentTypeResponse.UpdateContentTypeResult listUpdateContentType (UpdateContentType request)

    Updates the specified list content type.

    Parameters
    request Object containing update content type request

    listName: represents the name of the list on which the list content type resides.

    contentTypeId: represents the content type ID of the list content type to be updated.

    contentTypeProperties: represents the properties to update on the list content type. Format the properties as a ContentType element, and include the element attributes for the properties you want to update.

    newFields: represents the collection of columns to add to the list content type. Format the column collection as a FieldRefs element, where each FieldRef child element references a column to add to the list content type.

    updateFields: represents the collection of columns to update on the list content type. Format the column collection as a FieldRefs element, where each FieldRef references a column to update on the content type. In each FieldRef child element, include the element attributes for the column properties you want to update.

    deleteFields: string that represents the collection of columns to delete from the list content type. Format the column collection as a FieldRefs element, where each FieldRef references a column to delete from the content type. In each FieldRef child element, include the ID attributes for the column you want to delete.

    addToView: represents whether or not to add the content type columns to the list view. Specify true to add the columns to the list view, false to keep the columns hidden.
    Returns
    • UpdateContentTypeResponse.UpdateContentTypeResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult listUpdateContentTypeXmlDocument (UpdateContentTypeXmlDocument request)

    Adds or overwrites the specified XMLDocument element in the specified list content type.

    Parameters
    request Object containing update content type xml document request

    listName: string that represents the name of the list.

    contentTypeId: string that represents the content type ID of the content type to which to add or update the XMLDocument element.

    newDocument: string representing the XML document to replace the existing XML document.
    Returns
    • UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult listUpdateContentTypesXmlDocument (UpdateContentTypesXmlDocument request)

    Adds or overwrites the specified XMLDocument element for all content types on the specified list.

    Parameters
    request Object containing update content types xml document request

    listName: string that represents the name of the list.

    newDocument: string representing the XML document to replace the existing XML document.
    Returns
    • UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateListResponse.UpdateListResult listUpdateList (UpdateList request)

    Updates a list based on the specified field definitions and list properties.

    Parameters
    request Object containing list request

    listName: string that contains the GUID for the list.

    contentTypeId: to check the values allowed please refer to documentation.

    newFields: contains Field elements inside method blocks so that the add operations can be tracked individually. To add a new field to a list view through the UpdateList method, use the AddToView attribute of the Method element to specify the GUID of the view.

    updateFields: contains Field elements inside method blocks so that the update operations can be tracked individually.

    deleteFields: contains Field elements specifying the names of the fields to delete inside method blocks so that the delete operations can be tracked individually.

    listVersion: contains the version of the list that is being updated so that conflict detection can be performed.
    Returns
    • UpdateListResponse.UpdateListResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateListItemsResponse.UpdateListItemsResult listUpdateListItems (UpdateListItems request)

    Adds, deletes, or updates the specified items in a list on the current site.

    Parameters
    request Object containing list items request

    listName: string that contains the name of the list. It is recommended that you use the list GUID surrounded by curly braces (i.e., "{GUID}"), but you can also use the list display name.

    updates: item to be affected. For further information please check documentation.
    Returns
    • UpdateListItemsResponse.UpdateListItemsResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult listUpdateListItemsWithKnowledge (UpdateListItemsWithKnowledge request)

    Makes inserts, updates, and deletions to specified list items and provides the server with current knowledge metadata.

    Parameters
    request Object containing list item with knowledge request

    listName: GUID or the list title of the list from which to retrieve list items. If the specified list is the user information list, the string is set to "UserInfo" or "User Information list".

    updates: Specifies the operations to perform on a list item.. For further information please check documentation.

    syncScope: Specifies the scope of the synchronization. If null, the default sync scope is used with an empty identifier.

    knowledge: Specifies the Microsoft Sync Framework knowledge data structure in XML format. If not provided by the client, all items in the list are returned, subject to the default row limit of the view or the overriding rowLimit parameter. If specified, the response will include changes made to list items after the knowledge was retrieved, subject to the row limit restrictions.
    Returns
    • UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public AddMeetingResponse.AddMeetingResult meetingAddMeeting (String organizerEmail, String uid, long sequence, XMLGregorianCalendar utcDateStamp, String title, String location, XMLGregorianCalendar utcDateStart, XMLGregorianCalendar utcDateEnd, boolean nonGregorian)

    Associates a meeting with the Meeting Workspace site on the specified server running Windows SharePoint Services.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.addmeeting(v=office.14).aspx

    Parameters
    organizerEmail The e-mail address, specified as email_address@domain.ext, for the meeting organizer.
    uid A persistent GUID for the calendar component.
    sequence An integer used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is the same as the current sequence, the latest update will be applied.
    utcDateStamp The date and time that the instance of the iCalendar object was created.
    title The title (subject) of the meeting.
    location The location of the meeting.
    utcDateStart The start date and time for the meeting, expressed in UTC.
    utcDateEnd The end date and time for the meeting, expressed in Coordinated Universal Time (UTC).
    nonGregorian True if the calendar is set to a format other than Gregorian; otherwise, false. Setting this parameter to true puts the following message in the summary data of the meeting workspace: "This meeting was created using a calendar and scheduling program that only supports series updates to the Meeting Workspace. Changes you make to individual occurrences of meetings in that program will not appear in the workspace."
    Returns
    • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <AddMeetingResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/"> <AddMeetingResult> <AddMeeting Url="http://server_name/Test?InstanceID=1" HostTitle="Team Web Site" UniquePermissions="true" MeetingCount="1" AnonymousAccess="false" AllowAuthenticatedUsers="false" /> <AttendeeUpdateStatus Code="12" Detail="Some users could not automatically be granted permissions to the workspace." ManageUserPage="http://spserver1/Test/_layouts/1033/user.aspx" /> </AddMeetingResult> </AddMeetingResponse> </soap:Body></soap:Envelope>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public AddMeetingFromICalResponse.AddMeetingFromICalResult meetingAddMeetingFromICal (String organizerEmail, String icalText)

    Associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified server running Windows SharePoint Services.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.addmeetingfromical(v=office.14).aspx

    Parameters
    organizerEmail The e-mail address, specified as email_address@domain.ext, for the meeting organizer.
    icalText The iCal representation of the meeting that will be associated with the Meeting Workspace site.
    Returns
    • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <AddMeetingFromICalResponse xmlns= "http://schemas.microsoft.com/sharepoint/soap/meetings/"> <AddMeetingFromICalResult> <AddMeetingFromICal Url= "http://server_name/Test Meeting(2)?InstanceID=1" HostTitle="Team Web Site" UniquePermissions="true" MeetingCount="1" AnonymousAccess="false" AllowAuthenticatedUsers="false" /> </AddMeetingFromICalResult> </AddMeetingFromICalResponse> </soap:Body></soap:Envelope>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public CreateWorkspaceResponse.CreateWorkspaceResult meetingCreateWorkspace (String title, String templateName, long lcid, TimeZoneInf timeZoneInformation)

    Creates a new Meeting Workspace subsite on the specified server running Windows SharePoint Services.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.createworkspace(v=office.14).aspx

    Parameters
    title The title for the Meeting Workspace site that will be created.
    templateName The name of the template to use when the site is created. See Windows SharePoint Services template naming guidelines for specifying a configuration within a template.
    lcid The LCID (locale identifier) to use when the site is created.
    timeZoneInformation The time zone information to use when the site is created.
    Returns
    • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <CreateWorkspaceResponse xmlns= "http://schemas.microsoft.com/sharepoint/soap/meetings/"> <CreateWorkspaceResult> <CreateWorkspace Url="http://server_name/test/myworkspace" /> </CreateWorkspaceResult> </CreateWorkspaceResponse> </soap:Body> </soap:Envelope>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void meetingDeleteWorkspace ()

    Deletes the Meeting Workspace site from the specified server running Windows SharePoint Services.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.deleteworkspace(v=office.14).aspx

    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetMeetingWorkspacesResponse.GetMeetingWorkspacesResult meetingGetMeetingWorkspaces (boolean recurring)

    Lists the Meeting Workspace sites located in the root directory of the specified server running Windows SharePoint Services at the specified site location.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.getmeetingworkspaces(v=office.14).aspx

    Parameters
    recurring True if the meeting is recurring; otherwise, false.
    Returns
    • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the Meeting Workspace sites in the root directory of the specified server. For example: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body> <GetMeetingWorkspacesResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/"> <GetMeetingWorkspacesResult> <MeetingWorkspaces> <Workspace Url="http://server_name/ManagersOnly" Title="ManagersOnly" /> <Workspace Url="http://server_name/ManagersOnly(1)" Title="ManagersOnly" /> <Workspace Url="http://server_name/Testing" Title="Testing" /> <Workspace Url="http://server_name/Marketing" Title="Marketing" /> <Workspace Url="http://server_name/Untitled" Title="Untitled" /> <Workspace Url="http://server_name/Untitled(1)" Title="Untitled" /> <MeetingWorkspaces /> </GetMeetingWorkspacesResult> </GetMeetingWorkspacesResponse> </soap:Body> </soap:Envelope>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetMeetingsInformationResponse.GetMeetingsInformationResult meetingGetMeetingsInformation (long requestFlags, long lcid)

    Lists the languages and templates supported by the specified server running Windows SharePoint Services. It also specifies whether the caller has the ManageSubweb right on the Meeting Workspace site and shows other workspace settings, such as Anonymous Access, Unique Permissions, the meeting count, and AllAuthenticatedUsers.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.getmeetingsinformation(v=office.14).aspx

    Parameters
    requestFlags Can be one or more of the following flags OR-ed together:
    • canCreateMeetings (returns true or false to indicate whether the caller has ManageSubweb rights on the site being posted to)
    • templateLanguages (returns the list of languages for which templates are available)
    • templateList (returns the list of available Meeting Workspace templates available for the specified LCID)
    • workspacestatus (returns information about the workspace)

    For example, setting this parameter to 1 turns on the first bit, which returns whether you have the permission to create a meeting. Setting the parameter to 2 turns on the second bit, which returns the list of available template languages. Setting it to 3 turns on both the first and second bit and returns both sets of information.
    lcid The LCID (locale identifier) to which you want to limit the results.
    Returns
    • A Microsoft.SharePoint.SoapServer.SoapXml that contains the following: <MeetingsInformation> <AllowCreate>True</AllowCreate> <ListTemplateLanguages><LCID>1033</LCID></ListTemplateLanguages> <ListTemplates> <Template Name="MPS#0" Title="Basic Meeting Workspace" Id="2" Description="All the basics to plan, organize and track your meeting. This Meeting Workspace contains the following lists: Objectives, Attendees and Agenda." ImageUrl="http://sturton2g/_layouts/1033/images/ basic.gif" /> <Template Name="MPS#1" Title="Blank Meeting Workspace" Id="2" Description="A blank Meeting Workspace for you to customize based on your requirements." ImageUrl="http://sturton2g/_layouts/1033/images/ blank.gif" /> <Template Name="MPS#2" Title="Decision Meeting Workspace" Id="2" Description="A Meeting Workspace in which to review relevant documents and record decisions. This Meetings Workspace contains the following lists: Objectives, Attendees, Agenda, Document Libraries, Tasks and Decisions." ImageUrl="http://sturton2g/_layouts/1033/ images/decision.gif" /> <Template Name="MPS#3" Title="Social Meeting Workspace" Id="2" Description="A planning tool for social occasions, featuring a discussion board and a picture library to post pictures of the event. This Meeting Workspace contains the following lists and webparts: Attendees, Directions, Weather, Image/Logo, Things To Bring, Discussions and a Picture Library." ImageUrl="http://sturton2g/_layouts/1033/ images/social.gif" /> <Template Name="MPS#4" Title="Multipage Meeting Workspace" Id="2" Description="All the basics to plan, organize and track your meeting with multiple pages. This Meeting Workspace contains the following lists: Objectives, Attendees and Agenda in addition to two blank pages for you customize based on your requirements." ImageUrl="http://sturton2g/_layouts/1033/images/ training.gif" /> </ListTemplates> <WorkspaceStatus UniquePermissions="true" MeetingCount="0" AnonymousAccess="false" AllowAuthenticatedUsers="false" /> </MeetingsInformation>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void meetingRemoveMeeting (long recurrenceId, String uid, long sequence, XMLGregorianCalendar utcDateStamp, boolean cancelMeeting)

    Removes the association between a meeting and a Meeting Workspace site.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.removemeeting(v=office.14).aspx

    Parameters
    recurrenceId The recurrence ID for the meeting that needs its association removed. This parameter can be set to 0 for single-instance meetings.
    uid A persistent GUID for the calendar component.
    sequence An integer that is used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is equal to the current sequence, the latest update are applied.
    utcDateStamp The date and time that the instance of the iCalendar object was created. This parameter needs to be in the UTC format (for example, 2003-03-04T04:45:22-08:00).
    cancelMeeting True to delete a meeting; false to remove its association with a Meeting Workspace site.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void meetingRestoreMeeting (String uid)

    Restores and relinks a meeting that was previously removed from a meeting instance.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.restoremeeting(v=office.14).aspx

    Parameters
    uid A persistent GUID for the calendar component.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void meetingSetAttendeeResponse (String attendeeEmail, long recurrenceId, String uid, long sequence, XMLGregorianCalendar utcDateTimeOrganizerCriticalChange, XMLGregorianCalendar utcDateTimeAttendeeCriticalChange, AttendeeResponse response)

    Sets the attendee response for a meeting.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.setattendeeresponse(v=office.14).aspx

    Parameters
    attendeeEmail The e-mail address, specified as email_address@domain.ext, for the responding user.
    recurrenceId The recurrence ID for the meeting. For single instance meetings, this parameter can be set to zero.
    uid A persistent GUID for the calendar component.
    sequence An integer used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is equal to the current sequence, the latest update is applied.
    utcDateTimeOrganizerCriticalChange This parameter is ignored in this release; therefore, this parameter can be a default date time.
    utcDateTimeAttendeeCriticalChange The date and time when the instance of the attendee object was created, expressed in Coordinated Universal Time (UTC).
    response The response from the responding user (responseAccepted, responseTentative, or responseDeclined).
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void meetingSetWorkspaceTitle (String title)

    Sets the title of the Meeting Workspace site on the specified server running Windows SharePoint Services.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.setworkspacetitle(v=office.14).aspx

    Parameters
    title The title for the specified Meeting Workspace site. If the title exceeds 255 characters, it is truncated to the first 255 characters.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void meetingUpdateMeeting (String uid, long sequence, XMLGregorianCalendar utcDateStamp, String title, String location, XMLGregorianCalendar utcDateStart, XMLGregorianCalendar utcDateEnd, boolean nonGregorian)

    Updates the meeting information on a Meeting Workspace site.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.updatemeeting(v=office.14).aspx

    Parameters
    uid A persistent GUID for the calendar component.
    sequence An integer used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded.
    utcDateStamp The date and time that the instance of the iCalendar object was created in UTC format.
    title The title (subject) of the meeting.
    location The location of the meeting.
    utcDateStart The start date and time for the meeting, expressed in UTC.
    utcDateEnd The end date and time for the meeting, expressed in Coordinated Universal Time (UTC).
    nonGregorian True if the calendar is set to a format other than Gregorian; otherwise, false. Setting this parameter to true puts the following message in the summary data of the meeting workspace: "This meeting was created using a calendar and scheduling program that only supports series updates to the Meeting Workspace. Changes you make to individual occurrences of meetings in that program will not appear in the workspace."
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateMeetingFromICalResponse.UpdateMeetingFromICalResult meetingUpdateMeetingFromICal (String icalText, boolean ignoreAttendees)

    Updates meeting information stored in Internet Calendar (iCal) format.

    API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.updatemeetingfromical(v=office.14).aspx

    Parameters
    icalText The iCal representation of the updated meeting.
    ignoreAttendees True to skip processing of attendee information in the iCal; otherwise, false.
    Returns
    • A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body> <UpdateMeetingFromICalResponse xmlns= "http://schemas.microsoft.com/sharepoint/soap/meetings/"> <UpdateMeetingFromICalResult> <UpdateMeetingFromICal> <AttendeeUpdateStatus Code="0" Detail="" ManageUserPage="" /> </UpdateMeetingFromICal></UpdateMeetingFromICalResult> </UpdateMeetingFromICalResponse> </soap:Body></soap:Envelope>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public boolean peopleIsClaimsMode ()

    Indicates if it is Claims mode

    API link: http://msdn.microsoft.com/en-us/library/websvcpeople.people.isclaimsmode(v=office.14).aspx

    Returns
    • If is claims mode
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public ArrayOfPrincipalInfo peopleResolvePrincipals (PeopleArrayOfString principalKeys, List<String> principalType, boolean addToUserInfoList)

    Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.

    API link: Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.

    Parameters
    principalKeys Logon name of the principal.
    principalType SPPrincipalType object that specifies user scope and other information.
    addToUserInfoList Indicates whether to add the principal to a SPUserCollection that is associated with the Web site.
    Returns
    • A list of PrincipalInfo objects that is indexed and accessed by the logon name in the AccountName() field.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public ArrayOfPrincipalInfo peopleSearchPrincipals (String searchText, int maxResults, List<String> principalType)

    Returns an array of PrincipalInfo objects from the SPUserCollection for the Web site. All instances have the principal logon name specified in searchText. Only the maxResults objects can be added to the array.

    API link: http://msdn.microsoft.com/en-us/library/websvcpeople.people.searchprincipals(v=office.14).aspx

    Parameters
    searchText Principal logon name.
    maxResults Unless otherwise specified, the maximum number of principals that can be returned from a provider is 10.
    principalType SPPrincipalType object that specifies user scope and other information.
    Returns
    • A list of PrincipalInfo objects that is indexed and accessed by principal logon name.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void permissionAddPermission (String objectName, String objectType, String permissionIdentifier, String permissionType, int permissionMask)

    Modifies site-level permissions for the site group that exists on the site, or adds or modifies permissions to the specified list for the user, site group, or cross-site group that exists on the site.

    API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.addpermission(v=office.14).aspx

    Parameters
    objectName A string that contains the name of the list or site.
    objectType A string that specifies either List or Web.
    permissionIdentifier A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.
    permissionType A string that specifies user, group (cross-site group), or role (site group). The user or cross-site group has to be valid, and the site group has to already exist on the site.
    permissionMask A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ("|") in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void permissionAddPermissionCollection (String objectName, String objectType, AddPermissionCollection.PermissionsInfoXml permissionsInfoXml)

    Modifies site-level permissions for the specified collection of existing site groups, or adds or modifies permissions to the list for the specified collection of existing users, site groups, and cross-site groups.

    API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.addpermissioncollection(v=office.14).aspx

    Parameters
    objectName A string that contains the name of the list or site.
    objectType A string that specifies either List or Web.
    permissionsInfoXml XML fragment in the following format that specifies the permissions to add and that can be passed as a System.Xml.XmlNode object: <Permissions> <Users> <User LoginName= "DOMAIN\User_Alias" Email="Email_Address" Name="Display_Name" Notes="Notes" PermissionMask="138608641" /> . . . </Users> <Groups> <Group GroupName= "Cross-site_Group" PermissionMask= "1027801615" /> . . . </Groups> <Roles> <Role RoleName="Site_Group" PermissionMask="-1" /> . . . </Roles> </Permissions>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetPermissionCollectionResponse.GetPermissionCollectionResult permissionGetPermissionCollection (String objectName, String objectType)

    Returns the collection of permissions for a site or list.

    API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.getpermissioncollection(v=office.14).aspx

    Parameters
    objectName A string that contains the name of the list or site.
    objectType A string that specifies either List or Web.
    Returns
    • An XML fragment in the following form that can be assigned to a System.Xml.XmlNode object: <GetPermissionCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/"> <Permissions> <Permission MemberID="1073741829" Mask="-1" MemberIsUser="False" MemberGlobal="False" RoleName="Administrator" /> <Permission MemberID="1073741828" Mask="1029638927" MemberIsUser="False" MemberGlobal="False" RoleName="Web Designer" /> <Permission MemberID="1073741827" Mask="1027801615" MemberIsUser="False" MemberGlobal="False" RoleName="Contributor" /> <Permission MemberID="1073741826" Mask="138608641" MemberIsUser="False" MemberGlobal="False" RoleName="Reader" /> <Permission MemberID="1073741825" Mask="134283264" MemberIsUser="False" MemberGlobal="False" RoleName="Guest" /> <Permission MemberID="1073741830" Mask="134414337" MemberIsUser="False" MemberGlobal="False" RoleName="Site_Group1" /> <Permission MemberID="1073741831" Mask="134283265" MemberIsUser="False" MemberGlobal="False" RoleName="Site_Group2" /> . . . </GetPermissionCollection>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void permissionRemovePermission (String objectName, String objectType, String permissionIdentifier, String permissionType)

    Removes the specified permission from the list.

    API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.removepermission(v=office.14).aspx

    Parameters
    objectName A string that contains the name of the list.
    objectType A string that specifies List.
    permissionIdentifier A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.
    permissionType A string that specifies user, group (cross-site group), or role (site group).
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void permissionRemovePermissionCollection (String objectName, String objectType, RemovePermissionCollection.MemberIdsXml memberIdsXml)

    Removes permissions from the list for the specified members.

    API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.removepermissioncollection(v=office.14).aspx

    Parameters
    objectName A string that contains the name of the list.
    objectType A string that specifies List.
    memberIdsXml An XML fragment in the following format that specifies the permissions to remove and that can be passed as a System.Xml.XmlNode object:
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void permissionUpdatePermission (String objectName, String objectType, String permissionIdentifier, String permissionType, int permissionMask)

    Modifies site-level permissions for the specified site group, or modifies permissions to the list for the specified user, site group, or cross-site group.

    API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.updatepermission(v=office.14).aspx

    Parameters
    objectName A string that contains the name of the list or site.
    objectType A string that specifies either List or Web.
    permissionIdentifier A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.
    permissionType A string that specifies user, group (cross-site group), or role (site group). The user or cross-site group must be valid, and the site group must already exist on the site.
    permissionMask A 32-bit integer that specifies the new permission mask (for example, 134284064). The GetPermissionCollection can be used to return the permissions for the site or list.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String query (String queryXml)

    Returns an XML string containing the search results set for the specified query.

    API link: http://msdn.microsoft.com/en-us/library/websvcspsearch.queryservice.query(v=office.14).aspx

    SQL Search syntax link: http://msdn.microsoft.com/en-us/library/ms443580(v=office.12).aspx

    Parameters
    queryXml A string specifying the search query XML. The XML format is defined by the Microsoft.Search.Query Schema
    Returns
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataEnumerateFolder (String strFolderUrl, Holder<Long> enumerateFolderResult, Holder<ArrayOfSFPUrl> vUrls)

    Returns information about the files and folders within a folder on a SharePoint site.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.enumeratefolder(v=office.14).aspx

    Parameters
    strFolderUrl A string that contains the site-relative URL of the folder.
    enumerateFolderResult A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.
    vUrls Returns an array that contains information about the files and folders, including their URLs, the date and time that each item was last modified, and a Boolean value that specifies whether the item is a folder.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetAttachments (String strListName, String strItemId, Holder<Long> getAttachmentsResult, Holder<SitedataArrayOfString> vAttachments)

    Returns the URLs for all attachments to a specified item in a SharePoint list.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getattachments(v=office.14).aspx

    Parameters
    strListName A string that contains either the name of the list or the GUID of the list enclosed in curly braces ({}).
    strItemId A string that contains an integer specifying the identifier (ID) of the item.
    getAttachmentsResult A long indicating the result of the operation
    vAttachments A string array that contains the URLs of the attachments.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetChanges (ObjectType objectType, String contentDatabaseId, Holder<String> startChangeId, Holder<String> endChangeId, int timeout, Holder<String> getChangesResult, Holder<Boolean> moreChanges)

    Returns the changes that occurred on a site collection content from one moment in time to another.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getchanges(v=office.14).aspx

    Parameters
    objectType The change tracking space to report about, either "ContentDatabase" or "Site". All other objectType values, as defined in ObjectType should not be used. The server may treat all other types as "Site". Note that "Site" in the context of this parameter actually means site collection.
    contentDatabaseId GUID of the content database, known in advance or obtained by GetContent request.
    startChangeId Start change id
    endChangeId End change id
    timeout Timeout, in seconds, which the client gives the server to collect changes. The server MUST NOT spend more than this amount of time preparing the response.
    getChangesResult Indicates whether the server is aware of any more changes before the one marked by CurrentChangeId token. If the server has successfully collected all change records for the requested increment within the Timeout limit, then the server MUST specify moreChanges = false. Also in this case the server MUST set LastChangeId and CurrentChangeId to the same value. This tells the client that there are no more changes marked before the CurrentChangeId token. If the server was unable to collect all change records within the Timeout or other constraints, the server MUST specify moreChanges = true. This tells the client that it SHOULD repeat the request using the suggested LastChangeId and CurrentChangeId. If the server is unable to collect all change records because the client passed a LastChangeId token that is older than the server's change records, then the sever MUST return the following SOAP error in response to the GetChanges operation:
    moreChanges More changes
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetContent (ObjectType objectType, String objectId, String folderUrl, String itemId, boolean retrieveChildItems, boolean securityOnly, Holder<String> lastItemIdOnPage, Holder<String> getContentResult)

    A string representing information about the web application.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getcontent(v=office.14).aspx

    Parameters
    objectType The change tracking space to report about, either "ContentDatabase" or "Site". All other objectType values, as defined in ObjectType should not be used. The server may treat all other types as "Site". Note that "Site" in the context of this parameter actually means site collection.
    objectId Specifies the name or GUID of an object. The GUID should be enclosed in curly braces ({}).
    folderUrl Specifies the folder name or the URL of a folder. The URL may be a absolute URL or a server-relative URL.
    itemId Specifies the ID of the list item.
    retrieveChildItems Flag specifying whether to get information about the child sites, lists and folders.
    securityOnly Flag specifying whether to get all the information for a list item or items of a folder. If true, the operation must return only the mandatory information, else the operation must return all the information.
    lastItemIdOnPage Used for pagination. Clients use this to sequentially retrieve large amount of data.
    getContentResult Returns change information (ChangeId) about the content database and site collection. Also returns information about the web application, site collection, site, list, list item, folder and attachment.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetList (String strListName, Holder<Long> getListResult, Holder<SListMetadata> sListMetadata, Holder<ArrayOfSProperty> vProperties)

    Returns metadata from the specified SharePoint list.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getlist(v=office.14).aspx

    Parameters
    strListName A string that contains either the name of the list or the GUID of the list enclosed in curly braces ({}).
    getListResult A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.
    sListMetadata Returns metadata from the list.
    vProperties Returns an array that contains information about each field in the list, including its name, title, and type.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetListCollection (Holder<Long> getListCollectionResult, Holder<ArrayOfSList> vLists)

    Returns information about all the lists in the current SharePoint site.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getlistcollection(v=office.14).aspx

    Parameters
    getListCollectionResult A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.
    vLists A string that returns an array that contains information about the lists.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String sitedataGetListItems (String strListName, String strQuery, String strViewFields, long uRowLimit)

    Performs a query against the specified SharePoint list.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getlistitems(v=office.14).aspx

    Parameters
    strListName A string that contains the GUID of the list enclosed in curly braces ({}).
    strQuery A string in the following form containing the Where clause of a Query element that specifies a filter for the query: 
     <Where>
  <Lt>
    <FieldRef Name="ID" />
    <Value Type="Counter">3</Value>
  </Lt>
</Where>
    strViewFields A string in the following form containing the field references of a ViewFields element that specify which fields to return in the query: 
     <FieldRef Name="ID" />
<FieldRef Name="Title" />
    uRowLimit A 32-bit unsigned integer that specifies the number of rows to return in the query.
    Returns
    • A string in XML data format that contains a schema and the data returned through the query, as follows: 
       <xml xmlns:s="uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882" xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882" xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:z="#RowsetSchema">
  <s:Schema id="RowsetSchema">
    <s:ElementType name="row" content="eltOnly" rs:CommandTimeout="30">
      <s:AttributeType name="ows_Title" rs:name="Title" rs:number="1">
        <s:datatype dt:type="string" dt:maxLength="512" />
      </s:AttributeType>
      <s:AttributeType name="ows_Number" rs:name="Number" rs:number="2">
        <s:datatype dt:type="float" dt:maxLength="8" />
      </s:AttributeType>
      <s:AttributeType name="ows_ID" rs:name="ID" rs:number="3">
        <s:datatype dt:type="i4" dt:maxLength="4" />
      </s:AttributeType>
      <s:AttributeType name="ows_owshiddenversion" rs:name="owshiddenversion" rs:number="4">
        <s:datatype dt:type="i4" dt:maxLength="4" />
      </s:AttributeType>
    </s:ElementType>
  </s:Schema>
  <rs:data ItemCount="1">
    <z:row ows_Title="Value1" ows_Number="100.000000000000" ows_ID="1" ows_owshiddenversion="2" />
    <z:row ows_Title="Value2" ows_Number="100.000000000000" ows_ID="2" ows_owshiddenversion="2" />
    .
    .
    .
  </rs:data>
</xml>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetSite (Holder<Long> getSiteResult, Holder<SSiteMetadata> sSiteMetadata, Holder<ArrayOfSWebWithTime> vWebs, Holder<String> strUsers, Holder<String> strGroups, Holder<SitedataArrayOfString> vGroups)

    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.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getsite(v=office.14).aspx

    Parameters
    getSiteResult A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.
    sSiteMetadata Site metadata from the current site.
    vWebs An array containing information about the sites in the current site collection, including their URLs and the dates they were last modified.
    strUsers This parameter is not used but must be passed.
    strGroups Information about the cross-site groups on the current site in the following form: 
     <Groups>
  <Group ID="4" Name="Group1" 
     Description="Description" 
     OwnerID="1" OwnerIsUser=
     "True" />
  <Group ID="4" Name="Group2" 
     Description="Description" 
    OwnerID="1" OwnerIsUser=
    "True" />
</Groups>
    vGroups Information about the users in each cross-site group on the site in the following form: 
     <Users>
  <User ID="1" Sid="S-1-5-21-
     2127521184-1604012920-
     1887927527-76687" 
     Name="Display_Name" 
     LoginName="DOMAIN\User_Alias" 
     Email="Email_Address" Notes="" 
     IsSiteAdmin="True" 
     IsDomainGroup="False" />
  <User ID="1" Sid="S-1-5-21-
     2127521184-1604012920-
     1887927527-259353" 
     Name="Display_Name" 
     LoginName="DOMAIN\User_Alias" 
     Email="Email_Address" Notes="" 
     IsSiteAdmin="True" 
     IsDomainGroup="False" />
</Users>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetSiteAndWeb (String strUrl, Holder<Long> getSiteAndWebResult, Holder<String> strSite, Holder<String> strWeb)

    Returns the absolute URL of a subsite and the absolute URL of its top-level parent site based on the specified site URL.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getsiteandweb(v=office.14).aspx

    Parameters
    strUrl The absolute URL of the parent top-level site.
    getSiteAndWebResult A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.
    strSite The absolute URL of the subsite.
    strWeb The absolute URL of the subsite.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetSiteUrl (String url, Holder<Long> getSiteUrlResult, Holder<String> siteUrl, Holder<String> siteId)

    Returns the GUID and URL of the site collection to which the specified URL belongs.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getsiteurl(v=office.14).aspx

    Parameters
    url Undefined
    getSiteUrlResult Undefined
    siteUrl Undefined
    siteId Undefined
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetUrlSegments (String strURL, Holder<Boolean> getURLSegmentsResult, Holder<String> strWebID, Holder<String> strBucketID, Holder<String> strListID, Holder<String> strItemID)

    A string representing the identifiers of a site, list or list item depending on the specified URL. The behavior of the operation depends on the specified URL.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.geturlsegments(v=office.14).aspx

    Parameters
    strURL Specifies an absolute URL of any item in the context site.
    getURLSegmentsResult The result of the operation
    strWebID Specifies the GUID of the site. This GUID must be enclosed in curly braces ({}).
    strBucketID Specifies the GUID the external security provider. This GUID must be enclosed in curly braces ({}).
    strListID Specifies the GUID the list. This GUID must be enclosed in curly braces ({}).
    strItemID Specifies the ID of the list item.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitedataGetWeb (Holder<Long> getWebResult, Holder<SWebMetadata> sWebMetadata, Holder<ArrayOfSWebWithTime> vWebs, Holder<ArrayOfSListWithTime> vLists, Holder<ArrayOfSFPUrl> vFPUrls, Holder<String> strRoles, Holder<SitedataArrayOfString> vRolesUsers, Holder<SitedataArrayOfString> vRolesGroups)

    Returns site and list metadata, as well as information about the users and site groups for the current SharePoint site.

    API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getweb(v=office.14).aspx

    Parameters
    getWebResult A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.
    sWebMetadata Metadata from the current site.
    vWebs An array containing information about the subsites under the current site, including their URLs and the dates they were last modified.
    vLists An array containing information about the lists in the current site, including their GUIDS, Boolean values indicating whether they are empty, and the date they were last modified.
    vFPUrls This parameter is not used but must be passed.
    strRoles Information about the site groups on the current site in the following form: 
     <Roles>
  <Role ID="1073741825" Name=
     "Guest" Description="Can view 
     specific lists 
    or document libraries when 
    given permissions." Type="1" />
  <Role ID="1073741826" Name=
     "Reader" Description=
     "Has read-only access 
     to the Web site." Type="2" />
  <Role ID="1073741827" Name=
     "Contributor" Description=
     "Can add content to existing 
     document libraries and lists."
     Type="3" />
  <Role ID="1073741828" Name="Web 
     Designer" Description=
     "Can create lists and document
     libraries and customize pages 
     in the Web site." Type="4" />
  <Role ID="1073741829" Name=
     "Administrator" Description=
     "Has full control of the Web 
     site." Type="5" />
</Roles>
    vRolesUsers String array that contains information about the users for each site group in the following form: 
     <Users>
  <User ID="1" Sid="S-1-5-21-
     2127521184-1604012920-
     1887927527-76687" 
     Name="Display_Name" 
     LoginName="DOMAIN\User_Alias" 
     Email="Email_Address" Notes=""
     IsSiteAdmin="True" 
     IsDomainGroup="False" />
  <User ID="1" Sid="S-1-5-21-
     2127521184-1604012920-
     1887927527-259353" 
     Name="Display_Name" 
     LoginName="DOMAIN\User_Alias" 
     Email="Email_Address" Notes=""
     IsSiteAdmin="True" 
     IsDomainGroup="False" />
</Users>
    vRolesGroups String array that contains information about the cross-site groups that are members of each site group on the site in the following form: 
     <Groups>
  <Group ID="4" Name="Group1" 
     Description="Description" 
     OwnerID="1" OwnerIsUser=
     "True" />
  <Group ID="4" Name="Group2" 
     Description="Description" 
     OwnerID="1" 
     OwnerIsUser="True" />
</Groups>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String sitesCreateWeb (String url, String title, String description, String templateName, Long language, Long locale, Long collationLocale, Boolean uniquePermissions, Boolean anonymous, Boolean presence)

    Create Web

    API link: http://msdn.microsoft.com/en-us/library/ee658286(v=office.14).aspx

    Parameters
    url Url
    title Title
    description Description
    templateName Template Name
    language Language
    locale Locale
    collationLocale Collation Locale
    uniquePermissions Unique Permissions
    anonymous Anonymus
    presence Presence
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitesDeleteWeb (String url)

    Delete web

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.deleteweb(v=office.14).aspx

    Parameters
    url Url
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String sitesExportSolution (String solutionFileName, String title, String description, boolean fullReuseExportMode, boolean includeWebContent)

    Export Solution

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.exportsolution(v=office.14).aspx

    Parameters
    solutionFileName Solution File Name
    title Title
    description Description
    fullReuseExportMode Full Reuse Export Mode
    includeWebContent Include Web Content
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public int sitesExportWeb (String jobName, String webUrl, String dataPath, boolean includeSubwebs, boolean includeUserSecurity, boolean overWrite, int cabSize)

    Exports a Web site.

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.exportweb(v=office.14).aspx

    Parameters
    jobName The file name to use for content migration packages.
    webUrl The URL of the site to export.
    dataPath The directory location where content migration packages are placed.
    includeSubwebs True to include subwebs; otherwise, false.
    includeUserSecurity True to include site security groups and group membership information; otherwise, false.
    overWrite True to overwrite the content migration package if it exists; otherwise, false.
    cabSize Indicates the maximum size for the CMP (content migration package) file.
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String sitesGetSite (String siteUrl)

    Get Site

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getsite(v=office.14).aspx

    Parameters
    siteUrl Site Url
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void sitesGetSiteTemplates (long lcid, Holder<Long> getSiteTemplatesResult, Holder<ArrayOfTemplate> templateList)

    Returns information about the collection of site definitions and sites templates in the Web application.

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getsitetemplates(v=office.14).aspx

    Parameters
    lcid A 32-bit integer that specifies the locale identifier (LCID), for example, 1033 in English.
    getSiteTemplatesResult If successful, returns 0 as a Long
    templateList A template array whose elements provide fields containing information about each template.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String sitesGetUpdatedFormDigest ()

    Get Updated From Digest

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx

    Returns
    • Result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public FormDigestInformation sitesGetUpdatedFormDigestInformation (String url)

    Get Updated Form Digest Information

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx

    Parameters
    url Url
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public int sitesImportWeb (String jobName, String webUrl, SitesArrayOfString dataFiles, String logPath, boolean includeUserSecurity, boolean overWrite)

    Import web

    API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.importweb(v=office.14).aspx

    Parameters
    jobName Job Name
    webUrl Web Url
    dataFiles Data Files
    logPath Log Path
    includeUserSecurity Include User Security
    overWrite Over Write
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public DeleteAllVersionsResponse.DeleteAllVersionsResult versionsDeleteAllVersions (String fileName)

    Deletes all versions of the specified file.

    API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.deleteallversions(v=office.14).aspx

    Parameters
    fileName A string that contains the site-relative location of the folder name and file name of the file whose versions are to be deleted.
    Returns
    • An XML fragment in the following form 
       <results xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <list id="{26E516B0-8241-4B97-984D-000000000000" />
   
   

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public DeleteVersionResponse.DeleteVersionResult versionsDeleteVersion (String fileName, String fileVersion)

    Deletes the specified file version.

    API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.deleteversion(v=office.14).aspx

    Parameters
    fileName A string that contains the site-relative location of the folder name and file name of the file whose version is to be deleted.
    fileVersion A string that specifies the number of the file version to delete.
    Returns
    • An XML fragment in the following form 
       <results xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <list id="{26E516B0-8241-4B97-984D-000000000000" />
   
   
   
      .
      .
      .

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void versionsDeleteView (String listName, String viewName)

    Deletes the specified view of the specified list.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.deleteview(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    viewName A string that contains the GUID for the view.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetVersionsResponse.GetVersionsResult versionsGetVersions (String fileName)

    Returns information about the versions of the specified file.

    API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.getversions(v=office.14).aspx

    Parameters
    fileName A string that contains the site-relative URL of the file in the form Folder_Name/File_Name.
    Returns
    • An XML fragment in the following form 
       <results xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <list id="{26E516B0-8241-4B97-984D-000000000000" />
      
   
   
   
      .
      .
      .

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public RestoreVersionResponse.RestoreVersionResult versionsRestoreVersion (String fileName, String fileVersion)

    Restores the specified file version.

    API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.restoreversion(v=office.14).aspx

    Parameters
    fileName A string that contains the site-relative URL of the file in the form Folder_Name/File_Name.
    fileVersion A string that identifies the file version.
    Returns
    • An XML fragment in the following form 
       <results xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <list id="{26E516B0-8241-4B97-984D-000000000000" />
   
   
   
   
   
   

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public AddViewResponse.AddViewResult viewsAddView (String listName, String viewName, AddView.ViewFields viewFields, AddView.Query query, AddView.RowLimit rowLimit, String type, boolean makeViewDefault)

    Creates a view for the specified list.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.addview(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    viewName A string that contains the GUID for the view, which determines the view to use for the default view attributes represented by the query, viewFields, and rowLimit parameters. If this argument is not supplied, the default view is assumed.
    viewFields A ViewFields element that specifies which fields to return in the query and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewFields>
  <FieldRef Name="Title" />
  <FieldRef Name="ID" />
</ViewFields>
    query A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. For example, the following query returns list items where the ID is less than 3 and orders the items by title: 
     <Query>
  <Where>
      <Lt>
         <FieldRef Name="ID" />
         <Value Type="Counter">3</Value>
      </Lt>
   </Where>
   <OrderBy>
      <FieldRef Name="Title" />
   </OrderBy>
</Query>
    rowLimit A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins, and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: 
     <RowLimit Paged="True">100</RowLimit>
    type A string that specifies whether the view is an HTML view or a Datasheet view. Possible values include HTML and Grid.
    makeViewDefault True to make the view the default view for the list.
    Returns
    • A Introduction to Collaborative Application Markup Language (CAML) fragment in the following form that contains the view schema and can be assigned to a System.Xml.XmlNode object. 
       <AddViewResult>
  <View Name="{B5C3250A-1974-49E9-9F61-180F86704434" 
    DefaultView="TRUE" Type="HTML" DisplayName="All Contacts" 
    Url="Lists/Contacts/AllItems.htm" BaseViewID="1" xmlns=""> 
    100
    
      
      
      
      
      
      
    
    
      
        
        
      
    
    
    
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetViewResponse.GetViewResult viewsGetView (String listName, String viewName)

    Returns the schema of the specified view for the specified list.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.getview(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    viewName A string that contains the GUID for the view. If the view name is blank, the default view is returned.
    Returns
    • A fragment in Introduction to Collaborative Application Markup Language (CAML) in the following form 
       <View Name="{EE7C652F-9CBF-433F-B376-86B0EE989A06" 
  DefaultView="TRUE" Type="HTML" DisplayName="View_Name" 
  Url="Lists/Events/File_Name.aspx" BaseViewID="1">
  
    
      
        
        2003-03-03T00:00:00Z
      
    
  
  
    
    
    
    
    
    
    
  
  100

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetViewCollectionResponse.GetViewCollectionResult viewsGetViewCollection (String listName)

    Returns the display names, internal names, and URLs for the collection of views of the specified list.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.getviewcollection(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    Returns
    • A fragment in Introduction to Collaborative Application Markup Language (CAML) in the following form 
       <GetViewCollectionResult>
  <Views>
    <View DisplayName="Allitems" Name="{C1036607-EC8A-11d3-82AA-0050048394B0" 
      Url="List\Events\Allitems.aspx" />
    
    ...
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetViewHtmlResponse.GetViewHtmlResult viewsGetViewHtml (String listName, String viewName)

    Returns the full schema of the specified view for the specified list, including the HTML sections.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.getviewhtml(v=office.14).aspx

    Parameters
    listName A string that contains the name of the list.
    viewName A string that contains the GUID specifying the view.
    Returns
    • A fragment in Introduction to Collaborative Application Markup Language (CAML) in the following form 
       <GetViewHTMLResult>
  <View Name="{C1036607-EC8A-11d3-82AA-0050048394B0" DefaultView="TRUE" 
    Type="HTML" DisplayName="All Contacts" Url="Lists/Contacts/AllItems.htm" 
    BaseViewID="1" xmlns="">
    
    ...
    
    
    ...
    
    
    ...
    
    
    ...
    
    
    ...
      
    
    ...
    
    
    ...
     
    
    ...
    
    
    ...
    
    
    ...
    
    
       
       
       
       
       
       
    
    
      
        
        
      
    
    
      
    
    100
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateViewResponse.UpdateViewResult viewsUpdateView (String listName, String viewName, UpdateView.ViewProperties viewProperties, UpdateView.Query query, UpdateView.ViewFields viewFields, UpdateView.Aggregations aggregations, UpdateView.Formats formats, UpdateView.RowLimit rowLimit)

    Modifies the specified view of the specified list.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.updateview(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    viewName A string that contains the GUID for the view.
    viewProperties An XML fragment that contains all the view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.
    query A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles: 
     <Query>
  <Where>
    <Lt>
     <FieldRef Name="ID" />
     <Value Type="Counter">3</Value>
    </Lt>
  </Where>
  <OrderBy>
    <FieldRef Name="Title" />
  </OrderBy>
</Query>
    viewFields A ViewFields element that specifies which fields to return in the query and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewFields>
  <FieldRef Name="Title" />
  <FieldRef Name="ID" />
</ViewFields>
    aggregations An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Aggregations Value="On">
  <FieldRef Name="Title" Type="Count">
  <FieldRef Name="Number" Type="Sum">
</Aggregations>
    formats A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Formats>
  <FormatDef Type="RowHeight" Value="67" />
  <Format Name="Attachments">
    <FormatDef Type="ColWidth" Value="75" />
  </Format>
  <Format Name="LinkTitle">
    <FormatDef Type="WrapText" Value="1" />
    <FormatDef Type="ColWidth" Value="236" />
  </Format>
   ...
</Formats>
    rowLimit A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: 
     <RowLimit Paged="True">100</RowLimit>
    Returns
    • A Introduction to Collaborative Application Markup Language (CAML) fragment in the following form 
       <UpdateViewResult>
  <View Name="{B5C3250A-1974-49E9-9F61-180F86704434" DefaultView="TRUE" Type="HTML" 
    DisplayName="All Contacts" Url="Lists/Contacts/AllItems.htm" BaseViewID="1" xmlns=""> 
    
      
      
      
      
      
      
    
    
      
        
        
      
      
        
          
          Today + 1
        
      
    
    
      
    
    100
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateViewHtmlResponse.UpdateViewHtmlResult viewsUpdateViewHtml (String listName, String viewName, UpdateViewHtml.ViewProperties viewProperties, UpdateViewHtml.Toolbar toolbar, UpdateViewHtml.ViewHeader viewHeader, UpdateViewHtml.ViewBody viewBody, UpdateViewHtml.ViewFooter viewFooter, UpdateViewHtml.ViewEmpty viewEmpty, UpdateViewHtml.RowLimitExceeded rowLimitExceeded, UpdateViewHtml.Query query, UpdateViewHtml.ViewFields viewFields, UpdateViewHtml.Aggregations aggregations, UpdateViewHtml.Formats formats, UpdateViewHtml.RowLimit rowLimit)

    Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.updateviewhtml(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    viewName A string that contains the GUID for the view.
    viewProperties An XML fragment that contains all view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.
    toolbar A Toolbar element that sets the HTML used to render the toolbar in a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Toolbar Type="Standard">
  <IfEqual>
    <Expr1>
      <GetVar Name="SearchString" />
    </Expr1>
    <Expr2 />
    <Then>
    ...
</Toolbar>
    viewHeader A ViewHeader element that sets the HTML used to render the header of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewHeader>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0> ]]>
  </HTML>
  ...
</ViewHeader>
    viewBody A ViewBody element that sets the HTML used to render the body of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewBody>
  <HTML>
    <![CDATA[ <TR>]]>
  </HTML>
  <Fields>
    <HTML>
      <![CDATA[ <TD Class=" ]]> 
    </HTML>
    ...
</ViewBody>
    viewFooter A ViewFooter element that sets the HTML used to render the footer of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewFooter>
  <HTML>
    <![CDATA[ </TABLE> ]]>
  </HTML>
  <IfEqual>
  ...
</ViewFooter>
    viewEmpty A ViewEmpty element that contains the HTML used to render the page if the query returns no items and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewEmpty>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0><tr><td> ]]>
  </HTML>
  ...
</ViewEmpty>
    rowLimitExceeded A RowLimitExceeded element that specifies alternate rendering for when the specified row limit is exceeded and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <RowLimitExceeded>
  <HTML><![CDATA[ <table class="ms-summarycustombody" cellpadding=0 cellspacing=0 border=0 rules=rows>
  ...
    </td></tr></table> ]]>
  </HTML>
</RowLimitExceeded>
    query A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles: 
     <Query>
  <Where>
    <Lt>
      <FieldRef Name="ID" />
      <Value Type="Counter">3</Value>
    </Lt>
  </Where>
  <OrderBy>
    <FieldRef Name="Title" />
  </OrderBy>
</Query>
    viewFields A ViewFields element that specifies which fields to return in the query and in what order, and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewFields>
  <FieldRef Name="ID" />
  <FieldRef Name="Title" />
</ViewFields>
    aggregations An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Aggregations Value="On">
  <FieldRef Name="Title" Type="Count">
  <FieldRef Name="Number" Type="Sum">
</Aggregations>
    formats A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Formats>
  <FormatDef Type="RowHeight" Value="67" />
  <Format Name="Attachments">
    <FormatDef Type="ColWidth" Value="75" />
  </Format>
  <Format Name="LinkTitle">
    <FormatDef Type="WrapText" Value="1" />
    <FormatDef Type="ColWidth" Value="236" />
  </Format>
  ...
</Formats>
    rowLimit A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: 
     <RowLimit Paged="True">100</RowLimit>
    Returns
    • A CAML fragment in the following form that contains the view schema and that can be assigned to a System.Xml.XmlNode object. 
       <View Name="{54992C89-4F9F-4B2E-8E5A-F55C1C70831B" Type="HTML" DisplayName="MyView" Url="Lists/TestCustList/MyView.aspx" BaseViewID="1" xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  
    
    
    
    
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  100
  
  ...
  
  
  ...
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateViewHtml2Response.UpdateViewHtml2Result viewsUpdateViewHtml2 (String listName, String viewName, UpdateViewHtml2.ViewProperties viewProperties, UpdateViewHtml2.Toolbar toolbar, UpdateViewHtml2.ViewHeader viewHeader, UpdateViewHtml2.ViewBody viewBody, UpdateViewHtml2.ViewFooter viewFooter, UpdateViewHtml2.ViewEmpty viewEmpty, UpdateViewHtml2.RowLimitExceeded rowLimitExceeded, UpdateViewHtml2.Query query, UpdateViewHtml2.ViewFields viewFields, UpdateViewHtml2.Aggregations aggregations, UpdateViewHtml2.Formats formats, UpdateViewHtml2.RowLimit rowLimit, String openApplicationExtension)

    Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.

    API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.updateviewhtml2(v=office.14).aspx

    Parameters
    listName A string that contains the internal name of the list.
    viewName A string that contains the GUID for the view.
    viewProperties An XML fragment that contains all view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.
    toolbar A Toolbar element that sets the HTML used to render the toolbar in a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Toolbar Type="Standard">
  <IfEqual>
    <Expr1>
      <GetVar Name="SearchString" />
    </Expr1>
    <Expr2 />
    <Then>
    ...
</Toolbar>
    viewHeader A ViewHeader element that sets the HTML used to render the header of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewHeader>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0> ]]>
  </HTML>
  ...
</ViewHeader>
    viewBody A ViewBody element that sets the HTML used to render the body of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewBody>
  <HTML>
    <![CDATA[ <TR>]]>
  </HTML>
  <Fields>
    <HTML>
      <![CDATA[ <TD Class=" ]]> 
    </HTML>
    ...
</ViewBody>
    viewFooter A ViewFooter element that sets the HTML used to render the footer of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewFooter>
  <HTML>
    <![CDATA[ </TABLE> ]]>
  </HTML>
  <IfEqual>
  ...
</ViewFooter>
    viewEmpty A ViewEmpty element that contains the HTML used to render the page if the query returns no items and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewEmpty>
  <HTML>
    <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0><tr><td> ]]>
  </HTML>
  ...
</ViewEmpty>
    rowLimitExceeded A RowLimitExceeded element that specifies alternate rendering for when the specified row limit is exceeded and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <RowLimitExceeded>
  <HTML><![CDATA[ <table class="ms-summarycustombody" cellpadding=0 cellspacing=0 border=0 rules=rows>
  ...
    </td></tr></table> ]]>
  </HTML>
</RowLimitExceeded>
    query A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles: 
     <Query>
  <Where>
    <Lt>
      <FieldRef Name="ID" />
      <Value Type="Counter">3</Value>
    </Lt>
  </Where>
  <OrderBy>
    <FieldRef Name="Title" />
  </OrderBy>
</Query>
    viewFields A ViewFields element that specifies which fields to return in the query and in what order, and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <ViewFields>
  <FieldRef Name="ID" />
  <FieldRef Name="Title" />
</ViewFields>
    aggregations An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Aggregations Value="On">
  <FieldRef Name="Title" Type="Count">
  <FieldRef Name="Number" Type="Sum">
</Aggregations>
    formats A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example: 
     <Formats>
  <FormatDef Type="RowHeight" Value="67" />
  <Format Name="Attachments">
    <FormatDef Type="ColWidth" Value="75" />
  </Format>
  <Format Name="LinkTitle">
    <FormatDef Type="WrapText" Value="1" />
    <FormatDef Type="ColWidth" Value="236" />
  </Format>
  ...
</Formats>
    rowLimit A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: 
     <RowLimit Paged="True">100</RowLimit>
    openApplicationExtension Open Application Extension
    Returns
    • A CAML fragment in the following form that contains the view schema and that can be assigned to a System.Xml.XmlNode object. 
       <View Name="{54992C89-4F9F-4B2E-8E5A-F55C1C70831B" Type="HTML" DisplayName="MyView" Url="Lists/TestCustList/MyView.aspx" BaseViewID="1" xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  
    
    
    
    
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  100
  
  ...
  
  
  ...
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartAddWebPart (String pageUrl, String webPartXml, Storage storage)

    Adds a new Web Part to a Web Part Page.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.addwebpart(v=office.14).aspx

    Parameters
    pageUrl A string containing the URL of the Web Part Page.
    webPartXml A string containing the XML of the Web Part.
    storage A Storage value indicating how the Web Part was stored.
    Returns
    • A GUID that identifies the newly created Web Part.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartAddWebPartToZone (String pageUrl, String webPartXml, Storage storage, String zoneId, int zoneIndex)

    Add Web Part To Zone

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.addwebparttozone(v=office.14).aspx

    Parameters
    pageUrl Page Url
    webPartXml Web Part Xml
    storage Storage
    zoneId Zone Id
    zoneIndex Zone Index
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartAssociateWorkflowMarkup (String configUrl, String configVersion)

    Creates a new SPWorkflowAssociation object list applied in the /WorkflowConfig/Association/@ListID attribute in the associated configuration file. If the /WorkflowConfig/Association/@ListID attribute is not applied, the method creates a new SPWorkflowAssociation object on the Windows SharePoint Services 3.0 Web site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.associateworkflowmarkup(v=office.14).aspx

    Parameters
    configUrl The Web-relative URL for the configuration file in the configuration file format.
    configVersion The version number of the configuration file in the format NNNN.NNNN.
    Returns
    • An "Error" or "Success" message. A "Success" message contains the GUID of the new SPWorkflowAssociation.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartConvertWebPartFormat (String inputFormat, FormatConversionOption formatConversionOption)

    Convert Web Part Format

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.convertwebpartformat(v=office.14).aspx

    Parameters
    inputFormat Input Format
    formatConversionOption Format Conversion Option
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void webpartDeleteWebPart (String pageUrl, String storageKey, Storage storage)

    Deletes a dynamic Web Part from a Web Part Page.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.deletewebpart(v=office.14).aspx

    Parameters
    pageUrl A string containing the URL of the page containing the Web Part.
    storageKey A GUID that identifies of the Web Part.
    storage A Storage value indicating how the Web Part was stored.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartExecuteProxyUpdates (String updateData)

    Execute Proxy Updates

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.executeproxyupdates(v=office.14).aspx

    Parameters
    updateData Update Data
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartFetchLegalWorkflowActions ()

    Returns a string version of the actions file, as defined by the Actions File Schema

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.fetchlegalworkflowactions(v=office.14).aspx

    Returns
    • Returns the actions file as a string.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetAssemblyMetaData (String assemblyName, String baseTypes)

    Get Assembly Metadata

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getassemblymetadata(v=office.14).aspx

    Parameters
    assemblyName Name of the assembly for which metadata is retrieved
    baseTypes Base Types
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetBindingResourceData (String resourceName)

    Get Binding Resource Data

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getbindingresourcedata(v=office.14).aspx

    Parameters
    resourceName Resource Name
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetCustomControlListResponse.GetCustomControlListResult webpartGetCustomControlList ()

    Get Custom Control List

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getcustomcontrollist(v=office.14).aspx

    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetDataFromDataSourceControl (String dscXml, String contextUrl)

    Get Data From Data Source Control

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getdatafromdatasourcecontrol(v=office.14).aspx

    Parameters
    dscXml Dsc Xml
    contextUrl Context Url
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetExpandedListViewXml (String webId, String listViewXml, String listGuid, String listUrl, String listDisplayName, Boolean hasConnection, Boolean partialView)

    Get Expanded List View Xml

    API link: http://msdn.microsoft.com/en-us/library/ee658354(v=office.14).aspx

    Parameters
    webId Web Id
    listViewXml List View Xml
    listGuid List Guid
    listUrl List Url
    listDisplayName List Display Name
    hasConnection Has Connection
    partialView Partial View
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetFormCapabilityFromDataSourceControl (String dscXml)

    Get Form Capability From Data Source Control

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getformcapabilityfromdatasourcecontrol(v=office.14).aspx

    Parameters
    dscXml Dsc Xml
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetSafeAssemblyInfoResponse.GetSafeAssemblyInfoResult webpartGetSafeAssemblyInfo ()

    Get Safe Assembly Info

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getsafeassemblyinfo(v=office.14).aspx

    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetWebPart (String pageurl, String storageKey, Storage storage)

    Returns the XML data for a dynamic Web Part.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpart(v=office.14).aspx

    Parameters
    pageurl A string containing the URL of the page containing the Web Part
    storageKey A GUID that identifies the Web Part
    storage A Storage value indicating how the Web Part is stored
    Returns
    • A string containing the XML for a Web Part to include the type and assembly name fields.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetWebPart2 (String pageurl, String storageKey, Storage storage, SPWebServiceBehavior behavior)

    Returns the XML data for a dynamic Web Part.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpart2(v=office.14).aspx

    Parameters
    pageurl A string containing the URL of the page containing the Web Part
    storageKey A GUID that identifies the Web Part
    storage A Storage value indicating how the Web Part is stored
    behavior An SPWebServiceBehavior enumeration object indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0.
    Returns
    • A string containing the XML for a Web Part to include the type and assembly name fields.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetWebPartCrossPageCompatibility (String sourcePageUrl, String sourcePageContents, String targetPageUrl, String targetPageContents, String providerPartID, String lcid)

    Returns connection information for all parts on the target page and compatibility information of the source Web Part with all the parts on a target page, which is used to determine whether Web Parts on two different pages are compatible with each other.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartcrosspagecompatibility(v=office.14).aspx

    Parameters
    sourcePageUrl The URL of the source page.
    sourcePageContents A string containing the source of the .aspx source Web page.
    targetPageUrl The URL of the target page.
    targetPageContents A string containing the source of the .aspx target Web page.
    providerPartID A string containing the identifier of a part that resides on the source page.
    lcid A locale identifier for locale-specific properties.
    Returns
    • A string that contains the compatibility information of the providerPartID with all the parts on the target page, along with group and interface information for all the parts on the target page. This string is an XML data island.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetWebPartPage (String documentName, SPWebServiceBehavior behavior)

    Get Web Part Page

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpage(v=office.14).aspx

    Parameters
    documentName The name of the Web Part Page.
    behavior An SPWebServiceBehavior enumeration object indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0.
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetWebPartPageConnectionInfo (String sourcePageUrl, String sourcePageContents, String providerPartID, String lcid)

    Returns connection information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpageconnectioninfo(v=office.14).aspx

    Parameters
    sourcePageUrl The URL of the source page.
    sourcePageContents A string containing the source of the .aspx source Web page.
    providerPartID A string containing the identifier of a part that resides on the source page.
    lcid A locale identifier for locale-specific properties.
    Returns
    • A string that contains the group and interface information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page. This string is an XML data island.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetWebPartPageDocument (String documentName)

    Returns the Web Part Page, complete with the Web Parts and the properties included within each Web Part zone.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpagedocument(v=office.14).aspx

    Parameters
    documentName The name of the Web Part Page.
    Returns
    • A string that contains the Web Part Page and associated Web Parts and properties.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetWebPartPropertiesResponse.GetWebPartPropertiesResult webpartGetWebPartProperties (String pageUrl, Storage storage)

    Returns an XML string of all Web Parts associated with a Web Part Page.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartproperties(v=office.14).aspx

    Parameters
    pageUrl The URL of the page containing the Web Part.
    storage A Storage value indicating how the Web Part is stored.
    Returns
    • SoapXmlElement XML string for all the Web Parts on a Web Part Page. This includes the GUIDs, Web Part properties and their values, and Web Part previews in HTML.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetWebPartProperties2Response.GetWebPartProperties2Result webpartGetWebPartProperties2 (String pageUrl, Storage storage, SPWebServiceBehavior behavior)

    Returns an XML string of all Web Parts associated with a Web Part Page.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartproperties2(v=office.14).aspx

    Parameters
    pageUrl The URL of the page containing the Web Part.
    storage A Storage value indicating how the Web Part is stored.
    behavior An SPWebServiceBehavior enumeration object indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0.
    Returns
    • SoapXmlElement XML string for all the Web Parts on a Web Part Page. This includes the GUIDs, Web Part properties and their values, and Web Part previews in HTML.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartGetXmlDataFromDataSource (String queryXml)

    Returns XML data from the data source provider.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getxmldatafromdatasource(v=office.14).aspx

    Parameters
    queryXml A string containing the information to query the data source.
    Returns
    • A string that contains the XML results of the query.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartRemoveWorkflowAssociation (String configUrl, String configVersion)

    Removes all SPWorkflowAssociation objects on the list defined by the /WorkflowConfig/Association/@ListID value in the configuration file.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.removeworkflowassociation(v=office.14).aspx

    Parameters
    configUrl Web-relative URL to the configuration file.
    configVersion Version of the configuration file to be used.
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartRenderWebPartForEdit (String webPartXml)

    Returns an XML fragment that includes the Web Part property information and the rendering HTML.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.renderwebpartforedit(v=office.14).aspx

    Parameters
    webPartXml A string containing the Web Part XML data.
    Returns
    • A string that represents an XML fragment containing the Web Part property information and the rendering HTML.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void webpartSaveWebPart (String pageUrl, String storageKey, String webPartXml, Storage storage)

    Saves changes to an existing dynamic Web Part.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.savewebpart(v=office.14).aspx

    Parameters
    pageUrl The URL of the source page.
    storageKey A GUID that identifies the Web Part
    webPartXml A string containing the XML information on the Web Part.
    storage A Storage value indicating how the Web Part is stored
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void webpartSaveWebPart2 (String pageUrl, String storageKey, String webPartXml, Storage storage, boolean allowTypeChange)

    Saves changes to an existing dynamic Web Part, including a change to the Web Part type.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.savewebpart2(v=office.14).aspx

    Parameters
    pageUrl The URL of the source page.
    storageKey A GUID that identifies the Web Part.
    webPartXml A string containing the XML information on the Web Part.
    storage A Storage value indicating how the Web Part is stored
    allowTypeChange True to allow saving the Web Part as a different type; otherwise, false.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String webpartValidateWorkflowMarkupAndCreateSupportObjects (String workflowMarkupText, String rulesText, String configBlob, String flag)

    Creates a workflow task list, if one is not specified, or if the specified task list does not exist in the context Web site; also updates content types on the task list.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.validateworkflowmarkupandcreatesupportobjects(v=office.14).aspx

    Parameters
    workflowMarkupText XML that represents the definition of the workflow schedule; the format for this XML is the XOML format, as defined in Windows Workflow Foundations.
    rulesText XML that represents the definition of the conditional logic for a workflow schedule; the format for this XML is the RULES format, as defined in Windows Workflow Foundations.
    configBlob XML that represents the support objects necessary to be created or modified as a result of this action.
    flag Specifies whether to create the support objects. If set to 1 the method only do validation; if set to 2 to do validation and create the support objects, and all other values are disallowed.
    Returns
    • Returns an XML fragment in the following: 
       <Success>
<TaskList ID="TaskListID"/>
</Success>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String websCreateContentType (String displayName, String parentType, CreateContentType.NewFields newFields, CreateContentType.ContentTypeProperties contentTypeProperties)

    Creates a new site content type, with the specified columns and properties, on the site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.createcontenttype(v=office.14).aspx

    Parameters
    displayName A string that represents the display name of the new site content type.
    parentType A string that represents the content type ID of the parent content type on which to base the new site content type.
    newFields A string that represents the collection of columns to include on the new site content type. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element represents a reference to an existing column to include on the content type.
    contentTypeProperties A string that represents the properties to specify for the new site content type. Format the properties as a ContentType Element (ContentType) element, and include the element attributes for the properties you want to specify.
    Returns
    • Returns the content type ID of the new site content type.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void websCustomizeCss (String cssFile)

    Applies style sheet customization to a particular file.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.customizecss(v=office.14).aspx

    Parameters
    cssFile The CSS file
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public DeleteContentTypeResponse.DeleteContentTypeResult websDeleteContentType (String contentTypeId)

    Deletes the specified site content type from the site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.deletecontenttype(v=office.14).aspx

    Parameters
    contentTypeId A string that represents the content type ID of the site content type to delete.
    Returns
    • A string, in the following format, indicating that the method succeeded. 
       <Success xmlns="http://schemas.microsoft.com/sharepoint/soap/"/>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String websGetActivatedFeatures ()

    Returns a list of Features that are activated in the Web site and in its parent site collection.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getactivatedfeatures(v=office.14).aspx

    Returns
    • A string consisting of two comma-delimited parts, one that contains the IDs of Features that are activated in the site collection, and the other that contains the IDs of Features that are activated in the Web site.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetAllSubWebCollectionResponse.GetAllSubWebCollectionResult websGetAllSubWebCollection ()

    Returns the titles and URLs of all sites within the current site collection.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getallsubwebcollection(v=office.14).aspx

    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetColumnsResponse.GetColumnsResult websGetColumns ()

    Returns a collection of the column definitions for the columns available on the site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcolumns(v=office.14).aspx

    Returns
    • An XML fragment in the form of a Fields Element (List) element that can be assigned to a System.Xml.XmlNode object. 
       <Fields>
  <Field ID="{BA934502-D68D-4960-A54B-51E15FEF5FD3" 
    Name="ManagersName" 
    DisplayName="Manager's Name" 
    Group="Core Contact and Calendar Columns" 
    Type="Text" Sealed="TRUE" 
    AllowDeletion="TRUE" 
    xmlns="http://schemas.microsoft.com/sharepoint/soap/" />
  

 }
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetContentTypeResponse.GetContentTypeResult websGetContentType (String contentTypeId)

    Returns the content type definition for the specified site content type.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcontenttype(v=office.14).aspx

    Parameters
    contentTypeId A string that represents the content type ID of the site content type.
    Returns
    • An XML fragment in the form of a ContentType Element (ContentType) element that can be assigned to a System.Xml.XmlNode object. The following example return value is edited for clarity. 
       <ContentType 
    ID="0x010100C78DE4D7C0C57C43AF878D28256599CA" 
    Name="NewContentType" 
    Group="Custom Content Types" 
    Description="Create a new document." 
    Version="1" 
    xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  <Folder TargetName="Forms/NewContentType" />
  <Fields>
   …
  <DocumentTemplate TargetName="Forms/NewContentType/template.doc" />
  <XmlDocuments>
    …
  </XmlDocuments>
</ContentType>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetContentTypesResponse.GetContentTypesResult websGetContentTypes ()

    Returns a collection of content type definitions for all site content types on the specified site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcontenttypes(v=office.14).aspx

    Returns
    • An XML fragment in the following form 
       <ContentTypes xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  <ContentType 
      ID="0x010100C78DE4D7C0C57C43AF878D28256599CA" 
      Name="NewContentType" 
      Group="Custom Content Types" 
      Description="Create a new document." 
      Version="1" 
      xmlns="http://schemas.microsoft.com/sharepoint/soap/">
    <Folder TargetName="Forms/NewContentType" />
    <Fields>
     …
    <DocumentTemplate TargetName="Forms/NewContentType/template.doc" />
    <XmlDocuments>
      …
    </XmlDocuments>
  </ContentType>
  <ContentType 
    …
  </ContentType>
</ContentTypes>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public CustomizedPageStatus websGetCustomizedPageStatus (String fileUrl)

    Gets the customization (also known as "ghosted") status of the file with the specified URL.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcustomizedpagestatus(v=office.14).aspx

    Parameters
    fileUrl The File Url
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetListTemplatesResponse.GetListTemplatesResult websGetListTemplates ()

    Returns the collection of list template definitions for the current site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getlisttemplates(v=office.14).aspx

    Returns
    • A fragment in Collaborative Application Markup Language (CAML) in the following form 
       <ListTemplates xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <ListTemplate Name="custlist" DisplayName="Custom List" Type="100" 
      BaseType="0" OnQuickLaunch="TRUE" 
      SecurityBits="11" Description="Create a custom list when you want 
      to specify your own columns. The list opens as a Web page and 
      lets you add or edit items one at a time." 
      Image="/_layouts/images/itgen.gif" />
   <ListTemplate Name="gridlist" DisplayName="Custom List in 
      Datasheet View" Type="120" BaseType="0" 
      OnQuickLaunch="TRUE" SecurityBits="11" Description="Create a 
      custom list when you want to specify your own columns. The list 
      opens in a spreadsheet-like environment for convenient data 
      entry, editing, and formatting. It requires a Windows SharePoint 
      Services-compatible list datasheet control and ActiveX 
      control support." Image="/_layouts/images/itdatash.gif" />
   <ListTemplate Name="doclib" DisplayName="Document Library" 
      Type="101" BaseType="1" 
      OnQuickLaunch="TRUE" SecurityBits="11" Description="Create a 
      document library when you have a collection of documents or other 
      files that you want to share. Document libraries support features 
      such as subfolders, file versioning, and check-in/check-out." 
      Image="/_layouts/images/itdl.gif" DocumentTemplate="101" />
      .
      .
      .
</ListTemplates>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetObjectIdFromUrlResponse.GetObjectIdFromUrlResult websGetObjectIdFromUrl (String objectUrl)

    Get Object Id From Url

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getobjectidfromurl(v=office.14).aspx

    Parameters
    objectUrl Object Url
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetWebResponse.GetWebResult websGetWeb (String webUrl)

    Returns properties of a site (for example, name, description, and theme).

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getweb(v=office.14).aspx

    Parameters
    webUrl A string that contains the absolute URL of the site. To return information about the current site, a period (".") can be passed as the value of this parameter.
    Returns
    • An XML fragment in the following form 
       <Web Title="Site_Name" Url=
   "http://Server_Name/sites/Site_Name/Subsite_Name" 
   Description="Description" Language="1033" Theme="Theme" 
   xmlns="http://schemas.microsoft.com/sharepoint/soap/" />
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public GetWebCollectionResponse.GetWebCollectionResult websGetWebCollection ()

    Returns the titles and URLs of all sites directly beneath the current site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getwebcollection(v=office.14).aspx

    Returns
    • An XML fragment in the following form 
       <Webs xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <Web Title="Subsite1_Name" Url="http://Server_Name/[sites]/
      [Site_Name]/[Subsite1]" />
   <Web Title="Subsite2_Name" Url="http://Server_Name/[sites]/
      [Site_Name]/[Subsite2]" />
</Webs>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public RemoveContentTypeXmlDocumentResponse.RemoveContentTypeXmlDocumentResult websRemoveContentTypeXmlDocument (String contentTypeId, String documentUri)

    Removes the specified XmlDocument Element (ContentType) element from the specified site content type.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.removecontenttypexmldocument(v=office.14).aspx

    Parameters
    contentTypeId A string that represents the content type ID for the site content type.
    documentUri A string that represents the URI of the XMLDocument element to remove.
    Returns
    • A string, in the following format, indicating that the method succeeded. 
       <Success xmlns="http://schemas.microsoft.com/sharepoint/soap/"/>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void websRevertAllFileContentStreams ()

    Reverts the content streams of all files within the Web site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.revertallfilecontentstreams(v=office.14).aspx

    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void websRevertCss (String cssFile)

    Reverts style sheet customization of a file to the default style sheet.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.revertcss(v=office.14).aspx

    Parameters
    cssFile The Css File
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public void websRevertFileContentStream (String fileUrl)

    Reverts the content stream of the file with the specified URL.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.revertfilecontentstream(v=office.14).aspx

    Parameters
    fileUrl File Url
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateColumnsResponse.UpdateColumnsResult websUpdateColumns (UpdateColumns.NewFields newFields, UpdateColumns.UpdateFields updateFields, UpdateColumns.DeleteFields deleteFields)

    Creates, updates, or deletes one or more columns on the specified site.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.updatecolumns(v=office.14).aspx

    Parameters
    newFields A string that represents the collection of columns to create on the site. Format the column collection as a Fields Element (List) element, where each Field Element (List) child element defines a column to create on the site.
    updateFields A string that represents the collection of columns to update on the site. Format the column collection as a Fields Element (List) element, where each Field Element (List) child element defines a column to include on the site. In each Field Element (List) child element, include the element attributes for the column properties you want to update.
    deleteFields A string that represents the collection of columns to delete from the site. Format the column collection as a Fields Element (List) element, where each Field Element (List) child element defines a column to delete from the site. In each Field Element (List) child element, include the ID attributes for the column you want to delete.
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateContentTypeResponse.UpdateContentTypeResult websUpdateContentType (String contentTypeId, UpdateContentType.ContentTypeProperties contentTypeProperties, UpdateContentType.NewFields newFields, UpdateContentType.UpdateFields updateFields, UpdateContentType.DeleteFields deleteFields)

    Updates the specified site content type.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.updatecontenttype(v=office.14).aspx

    Parameters
    contentTypeId A string that represents the content type ID of the site content type to update.
    contentTypeProperties A string that represents the properties to update on the site content type. Format the properties as a ContentType Element (ContentType) element, and include the element attributes for the properties you want to update.
    newFields A string that represents the collection of columns to add to the site content type. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element references a site column to add to the site content type.
    updateFields A string that represents the collection of columns to update on the site. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element references a column to update on the site content type. In each FieldRef Element (ContentType) child element, include the element attributes for the column properties you want to update.
    deleteFields A string that represents the collection of columns to delete from the site content type. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element references a column to delete from the site content type. In each FieldRef Element (ContentType) child element, include the ID attributes for the column you want to delete.
    Returns
    • The result of the operation
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult websUpdateContentTypeXmlDocument (String contentTypeId, UpdateContentTypeXmlDocument.NewDocument newDocument)

    Adds or overwrites the specified XmlDocument Element (ContentType) element in the site content type.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.updatecontenttypexmldocument(v=office.14).aspx

    Parameters
    contentTypeId A string that represents the content type ID of the site content type.
    newDocument A string that represents the XML document to replace the existing XML document.
    Returns
    • A string, in the following format, indicating that the method succeeded. 
       <Success xmlns="http://schemas.microsoft.com/sharepoint/soap/"/>
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error

    public String websWebUrlFromPageUrl (String pageUrl)

    Returns the URL of the parent site for the specified page URL.

    API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.weburlfrompageurl(v=office.14).aspx

    Parameters
    pageUrl A string that contains the absolute URL of the page.
    Returns
    • A string that contains the site URL.
    Throws
    SharepointRuntimeException If something goes wrong this exception is throwed with a description of the error