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 static final Log LOG
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, String spn, String realm, String kdcLocation, String kerberosConfigFile)
Connect to the Sharepoint Service

Update: The connection now supports NTLM or Kerberos.

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 setSharepointAuthenticationClient(SharepointAuthenticationClient sharepointAuthenticationClient)
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).

FormDigestInformation sitesGetUpdatedFormDigestInformation(String url)
Get Updated Form Digest Information

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

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.

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.

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.

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.

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

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.

String webpartGetBindingResourceData(String resourceName)
Get Binding Resource Data

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.

GetCustomControlListResponse.GetCustomControlListResult webpartGetCustomControlList()
Get Custom Control List

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.

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

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.

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.

GetSafeAssemblyInfoResponse.GetSafeAssemblyInfoResult webpartGetSafeAssemblyInfo()
Get Safe Assembly Info

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.

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.

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 static final Log LOG

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, String spn, String realm, String kdcLocation, String kerberosConfigFile)

Connect to the Sharepoint Service

Update: The connection now supports NTLM or Kerberos. "username, password and serverUrl" are shared between the two types of authentication, but "spn, realm, kdcLocation, kerberosConfigFile" are Kerberos only.

For use NTLM Authentication: Only set the username, password and serverUrl.

For use Kerberos Authentication: Set all the NTLM parameters and also spn, and (real & kdcLocation) or kerberosConfigFile

Parameters
username Username for connect to the service
password Password for connect to the service
serverUrl The service Endpoint
spn The Service Provider Name of the Dynamics Server in OnPremise mode (this can be found in the organizationServiceUrl, under \)
realm The realm of the Authentication server (generally in upper case format)

Generate a default config file using only as dinamic parameters the realm and the kdcLocation

The configuration generated is: 

  [libdefaults]
  default_realm = realm
  default_tkt_enctypes = rc4-hmac aes128-cts des3-cbc-sha1 des-cbc-md5 des-cbc-crc
  default_tgs_enctypes = rc4-hmac aes128-cts des3-cbc-sha1 des-cbc-md5 des-cbc-crc
  permitted_enctypes   = rc4-hmac aes128-cts des3-cbc-sha1 des-cbc-md5 des-cbc-crc
 
 [realms]
  realm = {
  kdc = kdcLocation
  }
  [domain_realm]
  .realmInLowerCase = realm
  realmInLowerCase = realm
kdcLocation The location of the Authentication server (used in the config example for realm paramameter)
kerberosConfigFile If this is specified realm and kdcLocation are ignored. You can pass the Kerberos config file as a raw String with line breaks using the ? (interrogation) character
Throws
ConnectionException If the connection failed

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
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
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
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
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
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< /a>

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