Service

java.lang.Object
- com.independentsoft.share.Service

```
public class Service
extends java.lang.Object
```
Service class contains the methods to perform operations on SharePoint server.

Constructor Summary

Constructors
Constructor and Description
`Service()` Initializes a new instance of the Service class.
`Service(java.lang.String siteUrl)` Initializes a new instance of the Service class.
`Service(java.lang.String siteUrl, java.lang.String username, java.lang.String password)` Initializes a new instance of the Service class.
`Service(java.lang.String siteUrl, java.lang.String username, java.lang.String password, java.lang.String domain)` Initializes a new instance of the Service class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Field`	`addDependentLookupField(java.lang.String displayName, java.lang.String primaryLookupFieldId, java.lang.String showField, java.lang.String listId)` Adds the dependent lookup field.
`boolean`	`addRoleAssignment(int principalId, int roleId)` Adds the role assignment.
`boolean`	`applySiteTemplate(java.lang.String name)` Apply site template.
`boolean`	`applyTheme(java.lang.String colorPaletteUrl)` Apply theme.
`boolean`	`applyTheme(java.lang.String colorPaletteUrl, boolean shareGenerated)` Apply theme.
`boolean`	`applyTheme(java.lang.String colorPaletteUrl, java.lang.String fontSchemeUrl)` Apply theme.
`boolean`	`applyTheme(java.lang.String colorPaletteUrl, java.lang.String fontSchemeUrl, boolean shareGenerated)` Apply theme.
`boolean`	`applyTheme(java.lang.String colorPaletteUrl, java.lang.String fontSchemeUrl, java.lang.String backgroundImageUrl)` Apply theme.
`boolean`	`applyTheme(java.lang.String colorPaletteUrl, java.lang.String fontSchemeUrl, java.lang.String backgroundImageUrl, boolean shareGenerated)` Apply theme.
`boolean`	`approve(java.lang.String filePath)` Approve.
`boolean`	`approve(java.lang.String filePath, java.lang.String comment)` Approve.
`boolean`	`breakRoleInheritance()` Break role inheritance.
`boolean`	`breakRoleInheritance(boolean copyRoleAssignments)` Break role inheritance.
`boolean`	`breakRoleInheritance(boolean copyRoleAssignments, boolean clearSubscopes)` Break role inheritance.
`boolean`	`breakRoleInheritance(java.lang.String listId)` Break role inheritance.
`boolean`	`breakRoleInheritance(java.lang.String listId, boolean copyRoleAssignments)` Break role inheritance.
`boolean`	`breakRoleInheritance(java.lang.String listId, boolean copyRoleAssignments, boolean clearSubscopes)` Break role inheritance.
`boolean`	`breakRoleInheritance(java.lang.String listId, int itemId)` Break role inheritance.
`boolean`	`breakRoleInheritance(java.lang.String listId, int itemId, boolean copyRoleAssignments)` Break role inheritance.
`boolean`	`breakRoleInheritance(java.lang.String listId, int itemId, boolean copyRoleAssignments, boolean clearSubscopes)` Break role inheritance.
`void`	`cancelUploadFile(java.lang.String filePath, java.lang.String uploadId)` Stops the chunk upload session without saving the uploaded data.
`User`	`checkedOutByUser(java.lang.String filePath)` Checked out by user.
`boolean`	`checkIn(java.lang.String filePath)` Check in.
`boolean`	`checkIn(java.lang.String filePath, CheckInType type)` Check in.
`boolean`	`checkIn(java.lang.String filePath, CheckInType type, java.lang.String comment)` Check in.
`boolean`	`checkIn(java.lang.String filePath, java.lang.String comment)` Check in.
`boolean`	`checkOut(java.lang.String filePath)` Check out.
`boolean`	`copyFile(java.lang.String sourceFilePath, java.lang.String destinationFilePath)` Copy file.
`boolean`	`copyFile(java.lang.String sourceFilePath, java.lang.String destinationFilePath, boolean overwrite)` Copy file.
`Field`	`createField(Field field)` Creates the field.
`Field`	`createField(FieldCreationInfo field, java.lang.String listId)` Creates the field.
`Field`	`createField(FieldSchemaXml field)` Creates the field.
`Field`	`createField(FieldSchemaXml field, java.lang.String listId)` Creates the field.
`Field`	`createField(Field field, java.lang.String listId)` Creates the field.
`File`	`createFile(java.lang.String filePath, byte[] buffer)` Creates the file.
`File`	`createFile(java.lang.String filePath, byte[] buffer, boolean overwrite)` Creates the file.
`File`	`createFile(java.lang.String filePath, java.io.InputStream stream)` Creates the file.
`File`	`createFile(java.lang.String filePath, java.io.InputStream stream, boolean overwrite)` Creates the file.
`Folder`	`createFolder(java.lang.String folderPath)` Creates the folder.
`Group`	`createGroup(Group group)` Creates the group.
`List`	`createList(List list)` Creates the list.
`ListItem`	`createListItem(java.lang.String listId, ListItem listItem)` Creates the list item.
`Attachment`	`createListItemAttachment(java.lang.String listId, int itemId, java.io.File file)` Creates the list item attachment.
`Attachment`	`createListItemAttachment(java.lang.String listId, int itemId, java.lang.String fileName, byte[] buffer)` Creates the list item attachment.
`Attachment`	`createListItemAttachment(java.lang.String listId, int itemId, java.lang.String fileName, java.io.InputStream stream)` Creates the list item attachment.
`Role`	`createRole(Role role)` Creates the role.
`Site`	`createSite(SiteCreationInfo siteInfo)` Creates the site.
`File`	`createTemplateFile(java.lang.String filePath)` Creates the template file.
`File`	`createTemplateFile(java.lang.String filePath, TemplateFileType type)` Creates the template file.
`User`	`createUser(User user, int groupId)` Creates the user.
`View`	`createView(java.lang.String listId, View view)` Creates the view.
`boolean`	`createViewField(java.lang.String listId, java.lang.String viewId, java.lang.String fieldName)` Creates the view field.
`boolean`	`deleteAllFileVersions(java.lang.String filePath)` Delete all file versions.
`boolean`	`deleteAllViewFields(java.lang.String listId, java.lang.String viewId)` Delete all view fields.
`void`	`deleteField(java.lang.String id, java.lang.String listId)` Delete field.
`void`	`deleteFile(java.lang.String filePath)` Delete file.
`boolean`	`deleteFileVersion(java.lang.String filePath, int versionId)` Delete file version.
`boolean`	`deleteFileVersion(java.lang.String filePath, java.lang.String versionLabel)` Delete file version.
`void`	`deleteFolder(java.lang.String folderPath)` Delete folder.
`boolean`	`deleteGroup(int groupId)` Delete group.
`boolean`	`deleteGroup(java.lang.String loginName)` Delete group.
`void`	`deleteList(java.lang.String listId)` Delete list.
`void`	`deleteListItem(java.lang.String listId, int itemId)` Delete list item.
`void`	`deleteRole(int roleId)` Delete role.
`void`	`deleteSite()` Delete site.
`boolean`	`deleteUser(int userId, int groupId)` Delete user.
`boolean`	`deleteUser(java.lang.String loginName, int groupId)` Delete user.
`void`	`deleteView(java.lang.String listId, java.lang.String viewId)` Delete view.
`boolean`	`deleteViewField(java.lang.String listId, java.lang.String viewId, java.lang.String fieldName)` Delete view field.
`boolean`	`deny(java.lang.String filePath)` Deny.
`boolean`	`deny(java.lang.String filePath, java.lang.String comment)` Deny.
`User`	`ensureUser(java.lang.String loginName)` Ensure user.
`Group`	`getAssociatedMemberGroup()` Gets the associated member group.
`Group`	`getAssociatedOwnerGroup()` Gets the associated owner group.
`Group`	`getAssociatedVisitorGroup()` Gets the associated visitor group.
`java.lang.String`	`getAuthorizationCode()`
`java.lang.String`	`getAuthorizationCodeRedirectUri()`
`java.lang.String`	`getAuthorizationCodeRequestUri(java.lang.String redirectUri)`
`java.lang.String`	`getAuthorizationCodeRequestUri(java.lang.String redirectUri, java.lang.String responseMode)`
`java.lang.String`	`getAuthorizationCodeRequestUri(java.lang.String redirectUri, java.lang.String responseMode, java.lang.String state)`
`java.util.List<ContentType>`	`getAvailableContentTypes()` Gets the available content types.
`java.util.List<ContentType>`	`getAvailableContentTypes(java.util.List<IQueryOption> queryOptions)` Gets the available content types.
`List`	`getCatalog(ListTemplateType listTemplate)` Gets the catalog.
`java.util.List<Change>`	`getChanges(ChangeQuery query)` Gets the changes.
`java.util.List<Change>`	`getChanges(ChangeQuery query, java.util.List<IQueryOption> queryOptions)` Gets the changes.
`java.util.List<Change>`	`getChanges(ChangeQuery query, java.lang.String listId)` Gets the changes.
`java.util.List<Change>`	`getChanges(ChangeQuery query, java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the changes.
`java.lang.String`	`getClientAssertion()`
`org.apache.http.conn.HttpClientConnectionManager`	`getClientConnectionManager()` Gets connection manager.
`java.lang.String`	`getClientId()`
`java.lang.String`	`getClientSecret()`
`int`	`getConnectTimeout()` Returns setting for connect timeout.
`ContentType`	`getContentType(java.lang.String contentTypeId)` Gets the content type.
`ContentType`	`getContentType(java.lang.String listId, java.lang.String contentTypeId)` Gets the content type.
`java.util.List<FieldLink>`	`getContentTypeFieldLinks(java.lang.String contentTypeId)` Gets the content type field links.
`java.util.List<FieldLink>`	`getContentTypeFieldLinks(java.lang.String contentTypeId, java.util.List<IQueryOption> queryOptions)` Gets the content type field links.
`java.util.List<FieldLink>`	`getContentTypeFieldLinks(java.lang.String listId, java.lang.String contentTypeId)` Gets the content type field links.
`java.util.List<FieldLink>`	`getContentTypeFieldLinks(java.lang.String listId, java.lang.String contentTypeId, java.util.List<IQueryOption> queryOptions)` Gets the content type field links.
`java.util.List<Field>`	`getContentTypeFields(java.lang.String contentTypeId)` Gets the content type fields.
`java.util.List<Field>`	`getContentTypeFields(java.lang.String contentTypeId, java.util.List<IQueryOption> queryOptions)` Gets the content type fields.
`java.util.List<Field>`	`getContentTypeFields(java.lang.String listId, java.lang.String contentTypeId)` Gets the content type fields.
`java.util.List<Field>`	`getContentTypeFields(java.lang.String listId, java.lang.String contentTypeId, java.util.List<IQueryOption> queryOptions)` Gets the content type fields.
`java.util.List<ContentType>`	`getContentTypes()` Gets the content types.
`java.util.List<ContentType>`	`getContentTypes(java.lang.String listId)` Gets the content types.
`java.util.List<ContentType>`	`getContentTypes(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the content types.
`ContextInfo`	`getContextInfo()` Gets the context info.
`User`	`getCreatedByUser(java.lang.String filePath, int versionId)` Gets the created by user.
`User`	`getCurrentUser()` Gets the current user.
`org.apache.http.Header[]`	`getCustomHeaders()`
`java.util.List<ListTemplate>`	`getCustomListTemplates()` Gets the custom list templates.
`java.util.List<ListTemplate>`	`getCustomListTemplates(java.util.List<IQueryOption> queryOptions)` Gets the custom list templates.
`DeviceAuthorizationCode`	`getDeviceAuthorizationCode()`
`java.lang.String`	`getDeviceCode()`
`java.lang.String`	`getDomain()` Gets user's domain.
`java.util.List<BasePermission>`	`getEffectiveBasePermissions()` Gets the effective base permissions.
`EventReceiver`	`getEventReceiver(java.lang.String receiverId)` Gets the event receiver.
`java.util.List<EventReceiver>`	`getEventReceivers()` Gets the event receivers.
`java.util.List<EventReceiver>`	`getEventReceivers(java.util.List<IQueryOption> queryOptions)` Gets the event receivers.
`java.util.List<java.lang.String>`	`getFeatures()` Gets the features.
`java.util.List<java.lang.String>`	`getFeatures(java.util.List<IQueryOption> queryOptions)` Gets the features.
`Field`	`getField(java.lang.String id)` Gets the field.
`Field`	`getField(java.lang.String id, java.lang.String listId)` Gets the field.
`Field`	`getFieldByInternalNameOrTitle(java.lang.String name)` Gets the field by internal name or title.
`Field`	`getFieldByInternalNameOrTitle(java.lang.String name, java.lang.String listId)` Gets the field by internal name or title.
`Field`	`getFieldByTitle(java.lang.String title)` Gets the field by title.
`Field`	`getFieldByTitle(java.lang.String title, java.lang.String listId)` Gets the field by title.
`java.util.List<Field>`	`getFields()` Gets the fields.
`java.util.List<Field>`	`getFields(java.util.List<IQueryOption> queryOptions)` Gets the fields.
`java.util.List<FieldValue>`	`getFieldValues(java.lang.String listId, int itemId)` Gets the field values.
`java.util.List<FieldValue>`	`getFieldValues(java.lang.String listId, int itemId, java.util.List<IQueryOption> queryOptions)` Gets the field values.
`java.util.List<FieldValue>`	`getFieldValuesAsHtml(java.lang.String listId, int itemId)` Gets the field values.
`java.util.List<FieldValue>`	`getFieldValuesAsHtml(java.lang.String listId, int itemId, java.util.List<IQueryOption> queryOptions)` Gets the field values.
`File`	`getFile(java.lang.String filePath)` Gets the file.
`User`	`getFileAuthor(java.lang.String filePath)` Gets the file author.
`File`	`getFileByRelativePath(java.lang.String filePath)`
`byte[]`	`getFileContent(java.lang.String filePath)` Gets the file content.
`java.util.List<FieldValue>`	`getFileFieldValues(java.lang.String filePath)` Gets the field values.
`java.util.List<FieldValue>`	`getFileFieldValues(java.lang.String filePath, java.util.List<IQueryOption> queryOptions)` Gets the field values.
`java.util.List<Link>`	`getFileLinks(java.lang.String filePath)` Gets the list item links.
`ListItemInfo`	`getFileListItemInfo(java.lang.String filePath)` Gets the list id and item id of the file.
`java.util.List<File>`	`getFiles(java.lang.String folderPath)` Gets the files.
`java.util.List<File>`	`getFiles(java.lang.String folderPath, java.util.List<IQueryOption> queryOptions)` Gets the files.
`java.io.InputStream`	`getFileStream(java.lang.String filePath)` Gets the file stream.
`java.io.InputStream`	`getFileStreamByRelativePath(java.lang.String filePath)` Gets the file stream.
`FileVersion`	`getFileVersion(java.lang.String filePath, int versionId)` Gets the file version.
`java.util.List<FileVersion>`	`getFileVersions(java.lang.String filePath)` Gets the file versions.
`java.util.List<FileVersion>`	`getFileVersions(java.lang.String filePath, java.util.List<IQueryOption> queryOptions)` Gets the file versions.
`Folder`	`getFolder(java.lang.String folderPath)` Gets the folder.
`java.util.List<FieldValue>`	`getFolderFieldValues(java.lang.String folderPath)` Gets the field values.
`java.util.List<FieldValue>`	`getFolderFieldValues(java.lang.String folderPath, java.util.List<IQueryOption> queryOptions)` Gets the field values.
`java.util.List<Link>`	`getFolderLinks(java.lang.String folderPath)` Gets the folder links.
`ListItemInfo`	`getFolderListItemInfo(java.lang.String folderPath)` Gets the list id and item id of the folder.
`java.util.List<Folder>`	`getFolders(java.lang.String parentFolder)` Gets the folders.
`java.util.List<Folder>`	`getFolders(java.lang.String parentFolder, java.util.List<IQueryOption> queryOptions)` Gets the folders.
`Group`	`getGroup(int groupId)` Gets the group.
`Group`	`getGroup(java.lang.String loginName)` Gets the group.
`User`	`getGroupOwner(int groupId)` Gets the group owner.
`User`	`getGroupOwner(java.lang.String loginName)` Gets the group owner.
`java.util.List<Group>`	`getGroups()` Gets the groups.
`java.util.List<Group>`	`getGroups(java.util.List<IQueryOption> queryOptions)` Gets the groups.
`java.util.List<User>`	`getGroupUsers(int groupId)` Gets the group users.
`java.util.List<User>`	`getGroupUsers(int groupId, java.util.List<IQueryOption> queryOptions)` Gets the group users.
`java.util.List<User>`	`getGroupUsers(java.lang.String loginName)` Gets the group users.
`java.util.List<User>`	`getGroupUsers(java.lang.String loginName, java.util.List<IQueryOption> queryOptions)` Gets the group users.
`java.net.Proxy`	`getHttpURLConnectionProxy()` Gets HttpURLConnection proxy server.
`java.io.InputStream`	`getInputStream(java.lang.String url)` Gets the input stream.
`LimitedWebPartManager`	`getLimitedWebPartManager(java.lang.String filePath)` Gets the limited web part manager.
`LimitedWebPartManager`	`getLimitedWebPartManager(java.lang.String filePath, PersonalizationScope scope)` Gets the limited web part manager.
`List`	`getList(java.lang.String listId)` Gets the list.
`List`	`getListByTitle(java.lang.String title)` Gets the list by title.
`java.util.List<ContentType>`	`getListContentTypes(java.lang.String listId)` Gets the list content types.
`java.util.List<ContentType>`	`getListContentTypes(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the list content types.
`View`	`getListDefaultView(java.lang.String listId)` Gets the list default view.
`java.util.List<EventReceiver>`	`getListEventReceivers(java.lang.String listId)` Gets the list event receivers.
`java.util.List<EventReceiver>`	`getListEventReceivers(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the list event receivers.
`java.util.List<Field>`	`getListFields(java.lang.String listId)` Gets the list fields.
`java.util.List<Field>`	`getListFields(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the list fields.
`Form`	`getListForm(java.lang.String listId, java.lang.String formId)` Gets the list form.
`java.util.List<Form>`	`getListForms(java.lang.String listId)` Gets the list forms.
`java.util.List<Form>`	`getListForms(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the list forms.
`ListItem`	`getListItem(java.lang.String listId, int itemId)` Gets the list item.
`java.util.List<Attachment>`	`getListItemAttachments(java.lang.String listId, int itemId)` Gets the list item attachments.
`java.util.List<Attachment>`	`getListItemAttachments(java.lang.String listId, int itemId, java.util.List<IQueryOption> queryOptions)` Gets the list item attachments.
`java.util.List<Change>`	`getListItemChanges(java.lang.String listId, ChangeLogItemQuery query)` Gets the list item changes.
`java.util.List<Change>`	`getListItemChanges(java.lang.String listId, ChangeLogItemQuery query, java.util.List<IQueryOption> queryOptions)` Gets the list item changes.
`ContentType`	`getListItemContentType(java.lang.String listId, int itemId)` Gets the list item content type.
`java.util.List<Link>`	`getListItemLinks(java.lang.String filePath)` Gets the list item links.
`java.lang.String`	`getListItemProperty(java.lang.String listId, int itemId, java.lang.String propertyName)` Gets the list item property as xml string.
`java.util.List<ListItem>`	`getListItems(java.lang.String listId)` Gets the list items.
`java.util.List<ListItem>`	`getListItems(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the list items.
`RegionalSettings`	`getListRegionalSettings(java.lang.String listId)` Gets the list regional settings.
`java.util.List<List>`	`getLists()` Gets the lists.
`java.util.List<List>`	`getLists(java.util.List<IQueryOption> queryOptions)` Gets the lists.
`java.lang.String`	`getListSchemaXml(java.lang.String listId)` Gets the list schema xml.
`ServerSettings`	`getListServerSettings(java.lang.String listId)` Gets the list server settings.
`ListTemplate`	`getListTemplate(java.lang.String name)` Gets the list template.
`java.util.List<ListTemplate>`	`getListTemplates()` Gets the list templates.
`java.util.List<ListTemplate>`	`getListTemplates(java.util.List<IQueryOption> queryOptions)` Gets the list templates.
`User`	`getLockedByUser(java.lang.String filePath)` Gets the locked by user.
`java.lang.String`	`getLoginHostUri()` Gets login host uri.
`User`	`getModifiedByUser(java.lang.String filePath)` Gets the modified by user.
`NavigationNode`	`getNavigationNode(int id)` Gets the navigation node.
`java.util.List<NavigationNode>`	`getNavigationNodeChildren(int id)` Gets the navigation node children.
`java.util.List<NavigationNode>`	`getNavigationNodeChildren(int id, java.util.List<IQueryOption> queryOptions)` Gets the navigation node children.
`OAuthToken`	`getOAuthToken()`
`OAuthToken`	`getOAuthTokenWithAuthorizationCode(java.lang.String authorizationCode, java.lang.String authorizationCodeRedirectUri)`
`OAuthToken`	`getOAuthTokenWithAuthorizationCode(java.lang.String authorizationCode, java.lang.String authorizationCodeRedirectUri, java.lang.String clientSecret)`
`OAuthToken`	`getOAuthTokenWithClientAssertion(java.lang.String clientAssertion)`
`OAuthToken`	`getOAuthTokenWithClientSecret(java.lang.String clientSecret)`
`OAuthToken`	`getOAuthTokenWithDeviceAuthorizationCode(java.lang.String deviceCode)`
`OAuthToken`	`getOAuthTokenWithUsernamePassword(java.lang.String username, java.lang.String password)`
`OAuthToken`	`getOAuthTokenWithUsernamePassword(java.lang.String username, java.lang.String password, java.lang.String clientSecret)`
`OAuthToken`	`getOAuthTokenWithUsernamePassword(java.lang.String username, java.lang.String password, java.lang.String clientSecret, java.lang.String clientAssertion)`
`java.lang.String`	`getPassword()` Gets user's password.
`org.apache.http.HttpHost`	`getProxy()` Gets HttpClient proxy.
`org.apache.http.auth.Credentials`	`getProxyCredentials()` Gets proxy credentials.
`java.util.List<NavigationNode>`	`getQuickLaunch()` Gets the quick launch.
`java.util.List<NavigationNode>`	`getQuickLaunch(java.util.List<IQueryOption> queryOptions)` Gets the quick launch.
`int`	`getReadTimeout()` Returns setting for read timeout.
`RealmInfo`	`getRealmInfo()`
`RecycleBinItem`	`getRecycleBinItem(java.lang.String id)` Gets the recycle bin item.
`User`	`getRecycleBinItemAuthor(java.lang.String id)` Gets the recycle bin item author.
`User`	`getRecycleBinItemDeletedBy(java.lang.String id)` Gets the recycle bin item deleted by.
`java.util.List<RecycleBinItem>`	`getRecycleBinItems()` Gets the recycle bin items.
`java.util.List<RecycleBinItem>`	`getRecycleBinItems(java.util.List<IQueryOption> queryOptions)` Gets the recycle bin items.
`RegionalSettings`	`getRegionalSettings()` Gets the regional settings.
`java.util.List<Field>`	`getRelatedFields(java.lang.String listId)` Gets the related fields.
`java.util.List<Field>`	`getRelatedFields(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the related fields.
`org.apache.http.client.config.RequestConfig`	`getRequestConfig()` Gets request configuration.
`java.util.List<HttpHeader>`	`getRequestHttpHeaders()`
`java.util.List<HttpHeader>`	`getResponseHttpHeaders()`
`Role`	`getRole(int roleId)` Gets the role.
`Role`	`getRole(RoleType type)` Gets the role.
`Role`	`getRole(java.lang.String name)` Gets the role.
`java.util.List<java.lang.Integer>`	`getRoleAssignments()` Gets the role assignments.
`java.util.List<java.lang.Integer>`	`getRoleAssignments(int principalId)` Gets the role assignments.
`java.util.List<java.lang.Integer>`	`getRoleAssignments(java.util.List<IQueryOption> queryOptions)` Gets the role assignments.
`java.util.List<Role>`	`getRoles()` Gets the roles.
`java.util.List<Role>`	`getRoles(java.util.List<IQueryOption> queryOptions)` Gets the roles.
`Folder`	`getRootFolder()` Gets the root folder.
`java.util.List<java.lang.String>`	`getScope()`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType, java.lang.String responseMode)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType, java.lang.String responseMode, java.lang.String state)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType, java.lang.String responseMode, java.lang.String state, java.lang.String nonce)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType, java.lang.String responseMode, java.lang.String state, java.lang.String nonce, java.lang.String loginHint)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType, java.lang.String responseMode, java.lang.String state, java.lang.String nonce, java.lang.String loginHint, java.lang.String domainHint)`
`java.lang.String`	`getSignInRequestUri(java.lang.String redirectUri, java.lang.String responseType, java.lang.String responseMode, java.lang.String state, java.lang.String nonce, java.lang.String loginHint, java.lang.String domainHint, java.lang.String prompt)`
`Site`	`getSite()` Gets the site.
`java.util.List<SiteInfo>`	`getSiteInfos()` Gets the site infos.
`java.util.List<SiteInfo>`	`getSiteInfos(java.util.List<IQueryOption> queryOptions)` Gets the site infos.
`java.util.List<Site>`	`getSites()` Gets the sites.
`java.util.List<Site>`	`getSites(java.util.List<IQueryOption> queryOptions)` Gets the sites.
`java.util.List<SiteTemplate>`	`getSiteTemplates(Locale locale)` Gets the site templates.
`java.util.List<SiteTemplate>`	`getSiteTemplates(Locale locale, boolean includeCrossLanguage)` Gets the site templates.
`java.util.List<SiteTemplate>`	`getSiteTemplates(Locale locale, boolean includeCrossLanguage, java.util.List<IQueryOption> queryOptions)` Gets the site templates.
`java.util.List<SiteTemplate>`	`getSiteTemplates(Locale locale, java.util.List<IQueryOption> queryOptions)` Gets the site templates.
`java.lang.String`	`getSiteUrl()` Gets SharePoint site url.
`java.lang.String`	`getTenant()`
`ThemeInfo`	`getThemeInfo()` Gets the theme info.
`TimeZone`	`getTimeZone()` Gets the time zone.
`java.util.List<TimeZone>`	`getTimeZones()` Gets the time zones.
`java.util.List<TimeZone>`	`getTimeZones(java.util.List<IQueryOption> queryOptions)` Gets the time zones.
`java.util.List<NavigationNode>`	`getTopNavigationBar()` Gets the top navigation bar.
`java.util.List<NavigationNode>`	`getTopNavigationBar(java.util.List<IQueryOption> queryOptions)` Gets the top navigation bar.
`User`	`getUser(int userId)` Gets the user.
`User`	`getUser(int userId, int groupId)` Gets the user.
`User`	`getUser(java.lang.String loginName, int groupId)` Gets the user.
`java.lang.String`	`getUserAgent()` Gets the User-Agent.
`User`	`getUserByEmail(java.lang.String email, int groupId)` Gets the user by email.
`java.util.List<Role>`	`getUserCustomActions()` Gets the user custom actions.
`java.util.List<Role>`	`getUserCustomActions(java.util.List<IQueryOption> queryOptions)` Gets the user custom actions.
`java.util.List<BasePermission>`	`getUserEffectivePermissions(java.lang.String listId, int itemId, java.lang.String loginName)` Gets the user effective permissions.
`java.util.List<BasePermission>`	`getUserEffectivePermissions(java.lang.String listId, java.lang.String loginName)` Gets the user effective permissions.
`java.util.List<Group>`	`getUserGroups(int userId)` Gets the user groups.
`java.util.List<Group>`	`getUserGroups(int userId, java.util.List<IQueryOption> queryOptions)` Gets the user groups.
`List`	`getUserInfoList()` Gets the user info list.
`java.lang.String`	`getUsername()` Gets username.
`java.util.List<User>`	`getUsers()` Gets the users.
`java.util.List<User>`	`getUsers(int groupId)` Gets the users.
`java.util.List<User>`	`getUsers(int groupId, java.util.List<IQueryOption> queryOptions)` Gets the users.
`java.util.List<User>`	`getUsers(java.util.List<IQueryOption> queryOptions)` Gets the users.
`View`	`getView(java.lang.String listId, java.lang.String viewId)` Gets the view.
`View`	`getViewByTitle(java.lang.String listId, java.lang.String title)` Gets the view by title.
`java.util.List<java.lang.String>`	`getViewFields(java.lang.String listId, java.lang.String viewId)` Gets the view fields.
`java.util.List<java.lang.String>`	`getViewFields(java.lang.String listId, java.lang.String viewId, java.util.List<IQueryOption> queryOptions)` Gets the view fields.
`java.lang.String`	`getViewFieldsSchemaXml(java.lang.String listId, java.lang.String viewId)` Gets the view fields schema xml.
`java.lang.String`	`getViewHtml(java.lang.String listId, java.lang.String viewId)` Gets the view html.
`java.util.List<View>`	`getViews(java.lang.String listId)` Gets the views.
`java.util.List<View>`	`getViews(java.lang.String listId, java.util.List<IQueryOption> queryOptions)` Gets the views.
`java.util.List<WorkflowTemplate>`	`getWorkflowTemplates()` Gets the workflow templates.
`java.util.List<WorkflowTemplate>`	`getWorkflowTemplates(java.util.List<IQueryOption> queryOptions)` Gets the workflow templates.
`boolean`	`isAcceptGzipEncoding()` Return whether to accept GZIP encoding, that is, whether to send the HTTP "Accept-Encoding" header with "gzip" as value.
`boolean`	`isSharedNavigation()` Checks if is shared navigation.
`java.lang.String`	`loginAdfs()`
`boolean`	`moveFile(java.lang.String sourceFilePath, java.lang.String destinationFilePath)` Move file.
`boolean`	`moveFile(java.lang.String sourceFilePath, java.lang.String destinationFilePath, MoveOperation operation)` Move file.
`boolean`	`moveViewField(java.lang.String listId, java.lang.String viewId, java.lang.String fieldName, int index)` Move view field.
`boolean`	`publish(java.lang.String filePath)` Publish.
`boolean`	`publish(java.lang.String filePath, java.lang.String comment)` Publish.
`java.lang.String`	`recycleFile(java.lang.String filePath)` Recycle file.
`java.lang.String`	`recycleFolder(java.lang.String folderPath)` Recycle folder.
`java.lang.String`	`recycleList(java.lang.String listId)` Recycle list.
`java.lang.String`	`recycleListItem(java.lang.String listId, int itemId)` Recycle list item.
`OAuthToken`	`refreshOAuthToken()`
`OAuthToken`	`refreshOAuthToken(java.lang.String clientId, java.lang.String tenant, java.lang.String refreshToken)`
`OAuthToken`	`refreshOAuthToken(java.lang.String clientId, java.lang.String tenant, java.lang.String refreshToken, java.util.List<java.lang.String> scope)`
`OAuthToken`	`refreshOAuthToken(java.lang.String clientId, java.lang.String tenant, java.lang.String refreshToken, java.util.List<java.lang.String> scope, java.lang.String clientSecret)`
`boolean`	`removeRoleAssignment(int principalId, int roleId)` Removes the role assignment.
`void`	`renameFile(java.lang.String filePath, java.lang.String newName)` Renames file.
`void`	`renameFolder(java.lang.String folderPath, java.lang.String newName)` Renames folder.
`java.lang.String`	`renderListData(java.lang.String listId, java.lang.String viewXml)` Render list data.
`java.lang.String`	`renderListFormData(java.lang.String listId, int itemId, java.lang.String formId, ControlMode mode)` Render list form data.
`int`	`reserveListItemId(java.lang.String listId)` Reserve list item id.
`boolean`	`resetRoleInheritance(java.lang.String listId, int itemId)` Reset role inheritance.
`boolean`	`restoreFileVersion(java.lang.String filePath, java.lang.String versionLabel)` Restore file version.
`SearchResult`	`search(IRestriction restriction)` Search.
`SearchResult`	`search(IRestriction restriction)` Search.
`SearchResult`	`search(SearchQuery query)` Search.
`SearchResult`	`search(java.lang.String query)` Search.
`void`	`setAcceptGzipEncoding(boolean acceptGzipEncoding)` Set whether to accept GZIP encoding, that is, whether to send the HTTP "Accept-Encoding" header with "gzip" as value.
`void`	`setAuthorizationCode(java.lang.String authorizationCode)`
`void`	`setAuthorizationCodeRedirectUri(java.lang.String authorizationCodeRedirectUri)`
`void`	`setclientAssertion(java.lang.String clientAssertion)`
`void`	`setClientConnectionManager(org.apache.http.conn.HttpClientConnectionManager connectionManager)` Sets connection manager.
`void`	`setClientId(java.lang.String clientId)`
`void`	`setClientSecret(java.lang.String clientSecret)`
`void`	`setConnectTimeout(int connectTimeout)` Sets the specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by the HttpURLConnection.
`void`	`setCustomHeaders(org.apache.http.Header[] customHeaders)`
`void`	`setDeviceCode(java.lang.String deviceCode)`
`void`	`setDomain(java.lang.String domain)` Sets user's domain.
`void`	`setFieldValue(java.lang.String listId, int listItemId, FieldValue fieldValue)` Sets the field value.
`void`	`setFieldValues(java.lang.String listId, int listItemId, java.util.List<FieldValue> fieldValues)` Sets the field values.
`void`	`setFileFieldValue(java.lang.String filePath, FieldValue fieldValue)` Sets the field value.
`void`	`setFileFieldValues(java.lang.String filePath, java.util.List<FieldValue> fieldValues)` Sets the field values.
`void`	`setFolderFieldValue(java.lang.String folderPath, FieldValue fieldValue)` Set the folder field value.
`void`	`setFolderFieldValues(java.lang.String folderPath, java.util.List<FieldValue> fieldValues)` Set the folder field values.
`void`	`setHttpURLConnection(boolean useHttpURLConnection)` Sets the http url connection.
`void`	`setHttpURLConnectionProxy(java.net.Proxy httpURLConnectionProxy)` Sets HttpURLConnection proxy server.
`void`	`setLoginHostUri(java.lang.String loginHostUri)` Sets login host uri.
`void`	`setOAuthToken(OAuthToken oAuthToken)`
`void`	`setPassword(java.lang.String password)` Sets user's password.
`void`	`setProxy(org.apache.http.HttpHost proxy)` Sets HttpClient proxy.
`void`	`setProxyCredentials(org.apache.http.auth.Credentials proxyCredentials)` Sets proxy credentials.
`void`	`setReadTimeout(int readTimeout)` Sets the read timeout to the specified timeout, in milliseconds.
`void`	`setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)` Sets request configuration.
`boolean`	`setShowInDisplayForm(java.lang.String id, java.lang.String listId)` Sets the show in display form.
`boolean`	`setShowInDisplayForm(java.lang.String id, java.lang.String listId, boolean show)` Sets the show in display form.
`boolean`	`setShowInEditForm(java.lang.String id, java.lang.String listId)` Sets the show in edit form.
`boolean`	`setShowInEditForm(java.lang.String id, java.lang.String listId, boolean show)` Sets the show in edit form.
`boolean`	`setShowInNewForm(java.lang.String id, java.lang.String listId)` Sets the show in new form.
`boolean`	`setShowInNewForm(java.lang.String id, java.lang.String listId, boolean show)` Sets the show in new form.
`void`	`setSiteUrl(java.lang.String siteUrl)` Sets SharePoint site url.
`void`	`setTenant(java.lang.String tenant)`
`void`	`setUserAgent(java.lang.String userAgent)` Sets the User-Agent.
`void`	`setUsername(java.lang.String username)` Sets username.
`SuggestResult`	`suggest(SearchQuerySuggestion suggestion)` Suggest.
`SuggestResult`	`suggest(java.lang.String query)` Suggest.
`boolean`	`undoCheckOut(java.lang.String filePath)` Undo check out.
`boolean`	`unpublish(java.lang.String filePath)` Unpublish.
`boolean`	`unpublish(java.lang.String filePath, java.lang.String comment)` Unpublish.
`Field`	`updateField(Field field, java.lang.String listId)` Update field.
`void`	`updateFileContent(java.lang.String filePath, byte[] buffer)` Update file content.
`void`	`updateFileContent(java.lang.String filePath, java.io.InputStream stream)` Update file content.
`void`	`updateFolder(Folder folder)` Update folder.
`void`	`updateGroup(Group group)` Update group.
`void`	`updateList(List list)` Update list.
`void`	`updateListItem(java.lang.String listId, ListItem listItem)` Update list item.
`void`	`updateListItemAttachment(java.lang.String listId, int itemId, java.lang.String fileName, byte[] buffer)` Updates the list item attachment.
`void`	`updateListItemAttachment(java.lang.String listId, int itemId, java.lang.String fileName, java.io.InputStream stream)` Updates the list item attachment.
`void`	`updateRole(Role role)` Update role.
`void`	`updateSite(Site site)` Update site.
`User`	`updateUser(User user, int groupId)` Update user.
`void`	`updateView(java.lang.String listId, View view)` Update view.
`long`	`uploadFile(java.lang.String filePath, java.io.InputStream inputStream)` Uploads large file.
`long`	`uploadFile(java.lang.String filePath, java.io.InputStream inputStream, java.lang.String uploadId)` Uploads large file.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Service
```
public Service()
```
  Initializes a new instance of the Service class.
- Service
```
public Service(java.lang.String siteUrl)
```
  Initializes a new instance of the Service class.
  
  Parameters:
  
  siteUrl - The SharePoint site url. Example: "https://servername/site".
- Service
```
public Service(java.lang.String siteUrl,
               java.lang.String username,
               java.lang.String password)
```
  Initializes a new instance of the Service class.
  
  Parameters:
  
  siteUrl - The SharePoint site url. Example: "https://servername/site".
  
  username - Username
  
  password - Password
- Service
```
public Service(java.lang.String siteUrl,
               java.lang.String username,
               java.lang.String password,
               java.lang.String domain)
```
  Initializes a new instance of the Service class.
  
  Parameters:
  
  siteUrl - The SharePoint site url. Example: "https://servername/site".
  
  username - Username
  
  password - Password
  
  domain - User' domain

Method Detail

addDependentLookupField

public Field addDependentLookupField(java.lang.String displayName,
                                     java.lang.String primaryLookupFieldId,
                                     java.lang.String showField,
                                     java.lang.String listId)
                              throws ServiceException

Adds the dependent lookup field.

Parameters:: displayName - the display name; primaryLookupFieldId - the primary lookup field id; showField - the show field; listId - the list id
Returns:: the field
Throws:: ServiceException - the service exception

addRoleAssignment
```
public boolean addRoleAssignment(int principalId,
                                 int roleId)
                          throws ServiceException
```
Adds the role assignment.

Parameters:

principalId - the principal id

roleId - the role id

Returns:

true, if successful

Throws:

ServiceException - the service exception

applySiteTemplate
```
public boolean applySiteTemplate(java.lang.String name)
                          throws ServiceException
```
Apply site template.

Parameters:

name - the name

Returns:

true, if successful

Throws:

ServiceException - the service exception

applyTheme
```
public boolean applyTheme(java.lang.String colorPaletteUrl)
                   throws ServiceException
```
Apply theme.

Parameters:

colorPaletteUrl - the color palette url

Returns:

true, if successful

Throws:

ServiceException - the service exception

applyTheme
```
public boolean applyTheme(java.lang.String colorPaletteUrl,
                          boolean shareGenerated)
                   throws ServiceException
```
Apply theme.

Parameters:

colorPaletteUrl - the color palette url

shareGenerated - the share generated

Returns:

true, if successful

Throws:

ServiceException - the service exception

applyTheme
```
public boolean applyTheme(java.lang.String colorPaletteUrl,
                          java.lang.String fontSchemeUrl)
                   throws ServiceException
```
Apply theme.

Parameters:

colorPaletteUrl - the color palette url

fontSchemeUrl - the font scheme url

Returns:

true, if successful

Throws:

ServiceException - the service exception

applyTheme

public boolean applyTheme(java.lang.String colorPaletteUrl,
                          java.lang.String fontSchemeUrl,
                          boolean shareGenerated)
                   throws ServiceException

Apply theme.

Parameters:: colorPaletteUrl - the color palette url; fontSchemeUrl - the font scheme url; shareGenerated - the share generated
Returns:: true, if successful
Throws:: ServiceException - the service exception

applyTheme

public boolean applyTheme(java.lang.String colorPaletteUrl,
                          java.lang.String fontSchemeUrl,
                          java.lang.String backgroundImageUrl)
                   throws ServiceException

Apply theme.

Parameters:: colorPaletteUrl - the color palette url; fontSchemeUrl - the font scheme url; backgroundImageUrl - the background image url
Returns:: true, if successful
Throws:: ServiceException - the service exception

applyTheme

public boolean applyTheme(java.lang.String colorPaletteUrl,
                          java.lang.String fontSchemeUrl,
                          java.lang.String backgroundImageUrl,
                          boolean shareGenerated)
                   throws ServiceException

Apply theme.

Parameters:: colorPaletteUrl - the color palette url; fontSchemeUrl - the font scheme url; backgroundImageUrl - the background image url; shareGenerated - the share generated
Returns:: true, if successful
Throws:: ServiceException - the service exception

approve
```
public boolean approve(java.lang.String filePath)
                throws ServiceException
```
Approve.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

approve

public boolean approve(java.lang.String filePath,
                       java.lang.String comment)
                throws ServiceException

Approve.

Parameters:: filePath - the file path; comment - the comment
Returns:: true, if successful
Throws:: ServiceException - the service exception

breakRoleInheritance
```
public boolean breakRoleInheritance()
                             throws ServiceException
```
Break role inheritance.

Returns:

true, if successful

Throws:

ServiceException - the service exception

breakRoleInheritance
```
public boolean breakRoleInheritance(boolean copyRoleAssignments)
                             throws ServiceException
```
Break role inheritance.

Parameters:

copyRoleAssignments - the copy role assignments

Returns:

true, if successful

Throws:

ServiceException - the service exception

breakRoleInheritance
```
public boolean breakRoleInheritance(boolean copyRoleAssignments,
                                    boolean clearSubscopes)
                             throws ServiceException
```
Break role inheritance.

Parameters:

copyRoleAssignments - the copy role assignments

clearSubscopes - the clear subscopes

Returns:

true, if successful

Throws:

ServiceException - the service exception

breakRoleInheritance
```
public boolean breakRoleInheritance(java.lang.String listId)
                             throws ServiceException
```
Break role inheritance.

Parameters:

listId - the list id

Returns:

true, if successful

Throws:

ServiceException - the service exception

breakRoleInheritance
```
public boolean breakRoleInheritance(java.lang.String listId,
                                    boolean copyRoleAssignments)
                             throws ServiceException
```
Break role inheritance.

Parameters:

listId - the list id

copyRoleAssignments - the copy role assignments

Returns:

true, if successful

Throws:

ServiceException - the service exception

breakRoleInheritance

public boolean breakRoleInheritance(java.lang.String listId,
                                    boolean copyRoleAssignments,
                                    boolean clearSubscopes)
                             throws ServiceException

Break role inheritance.

Parameters:: listId - the list id; copyRoleAssignments - the copy role assignments; clearSubscopes - the clear subscopes
Returns:: true, if successful
Throws:: ServiceException - the service exception

breakRoleInheritance

public boolean breakRoleInheritance(java.lang.String listId,
                                    int itemId)
                             throws ServiceException

Break role inheritance.

Parameters:: listId - the list id; itemId - the item id
Returns:: true, if successful
Throws:: ServiceException - the service exception

breakRoleInheritance

public boolean breakRoleInheritance(java.lang.String listId,
                                    int itemId,
                                    boolean copyRoleAssignments)
                             throws ServiceException

Break role inheritance.

Parameters:: listId - the list id; itemId - the item id; copyRoleAssignments - the copy role assignments
Returns:: true, if successful
Throws:: ServiceException - the service exception

breakRoleInheritance

public boolean breakRoleInheritance(java.lang.String listId,
                                    int itemId,
                                    boolean copyRoleAssignments,
                                    boolean clearSubscopes)
                             throws ServiceException

Break role inheritance.

Parameters:: listId - the list id; itemId - the item id; copyRoleAssignments - the copy role assignments; clearSubscopes - the clear subscopes
Returns:: true, if successful
Throws:: ServiceException - the service exception

cancelUploadFile
```
public void cancelUploadFile(java.lang.String filePath,
                             java.lang.String uploadId)
                      throws ServiceException
```
Stops the chunk upload session without saving the uploaded data. If the file doesn�t already exist in the library, the partially uploaded file will be deleted.

Parameters:

filePath - The file path

uploadId - Upload ID (GUID)

Throws:

ServiceException

checkedOutByUser
```
public User checkedOutByUser(java.lang.String filePath)
                      throws ServiceException
```
Checked out by user.

Parameters:

filePath - the file path

Returns:

the user

Throws:

ServiceException - the service exception

checkIn
```
public boolean checkIn(java.lang.String filePath)
                throws ServiceException
```
Check in.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

checkIn

public boolean checkIn(java.lang.String filePath,
                       CheckInType type)
                throws ServiceException

Check in.

Parameters:: filePath - the file path; type - the type
Returns:: true, if successful
Throws:: ServiceException - the service exception

checkIn

public boolean checkIn(java.lang.String filePath,
                       CheckInType type,
                       java.lang.String comment)
                throws ServiceException

Check in.

Parameters:: filePath - the file path; type - the type; comment - the comment
Returns:: true, if successful
Throws:: ServiceException - the service exception

checkIn

public boolean checkIn(java.lang.String filePath,
                       java.lang.String comment)
                throws ServiceException

Check in.

Parameters:: filePath - the file path; comment - the comment
Returns:: true, if successful
Throws:: ServiceException - the service exception

checkOut
```
public boolean checkOut(java.lang.String filePath)
                 throws ServiceException
```
Check out.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

copyFile
```
public boolean copyFile(java.lang.String sourceFilePath,
                        java.lang.String destinationFilePath)
                 throws ServiceException
```
Copy file.

Parameters:

sourceFilePath - the source file path

destinationFilePath - the destination file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

copyFile

public boolean copyFile(java.lang.String sourceFilePath,
                        java.lang.String destinationFilePath,
                        boolean overwrite)
                 throws ServiceException

Copy file.

Parameters:: sourceFilePath - the source file path; destinationFilePath - the destination file path; overwrite - the overwrite
Returns:: true, if successful
Throws:: ServiceException - the service exception

createField
```
public Field createField(Field field)
                  throws ServiceException
```
Creates the field.

Parameters:

field - the field

Returns:

the field

Throws:

ServiceException - the service exception

createField

public Field createField(FieldCreationInfo field,
                         java.lang.String listId)
                  throws ServiceException

Creates the field.

Parameters:: field - the field; listId - the list id
Returns:: the field
Throws:: ServiceException - the service exception

createField
```
public Field createField(FieldSchemaXml field)
                  throws ServiceException
```
Creates the field.

Parameters:

field - the field

Returns:

the field

Throws:

ServiceException - the service exception

createField

public Field createField(FieldSchemaXml field,
                         java.lang.String listId)
                  throws ServiceException

Creates the field.

Parameters:: field - the field; listId - the list id
Returns:: the field
Throws:: ServiceException - the service exception

createField

public Field createField(Field field,
                         java.lang.String listId)
                  throws ServiceException

Creates the field.

Parameters:: field - the field; listId - the list id
Returns:: the field
Throws:: ServiceException - the service exception

createFile
```
public File createFile(java.lang.String filePath,
                       byte[] buffer)
                throws ServiceException
```
Creates the file.

Parameters:

filePath - the file path

buffer - the buffer

Returns:

the file

Throws:

ServiceException - the service exception

createFile

public File createFile(java.lang.String filePath,
                       byte[] buffer,
                       boolean overwrite)
                throws ServiceException

Creates the file.

Parameters:: filePath - the file path; buffer - the buffer; overwrite - the overwrite
Returns:: the file
Throws:: ServiceException - the service exception

createFile

public File createFile(java.lang.String filePath,
                       java.io.InputStream stream)
                throws ServiceException

Creates the file.

Parameters:: filePath - the file path; stream - the stream
Returns:: the file
Throws:: ServiceException - the service exception

createFile

public File createFile(java.lang.String filePath,
                       java.io.InputStream stream,
                       boolean overwrite)
                throws ServiceException

Creates the file.

Parameters:: filePath - the file path; stream - the stream; overwrite - the overwrite
Returns:: the file
Throws:: ServiceException - the service exception

createFolder
```
public Folder createFolder(java.lang.String folderPath)
                    throws ServiceException
```
Creates the folder.

Parameters:

folderPath - the folder path

Returns:

the folder

Throws:

ServiceException - the service exception

createGroup
```
public Group createGroup(Group group)
                  throws ServiceException
```
Creates the group.

Parameters:

group - the group

Returns:

the group

Throws:

ServiceException - the service exception

createList
```
public List createList(List list)
                throws ServiceException
```
Creates the list.

Parameters:

list - the list

Returns:

the com.independentsoft.share. list

Throws:

ServiceException - the service exception

createListItem

public ListItem createListItem(java.lang.String listId,
                               ListItem listItem)
                        throws ServiceException

Creates the list item.

Parameters:: listId - the list id; listItem - the list item
Returns:: the list item
Throws:: ServiceException - the service exception

createListItemAttachment

public Attachment createListItemAttachment(java.lang.String listId,
                                           int itemId,
                                           java.io.File file)
                                    throws ServiceException,
                                           java.io.IOException

Creates the list item attachment.

Parameters:: listId -; itemId -; stream -
Returns:
Throws:: ServiceException; java.io.IOException

createListItemAttachment

public Attachment createListItemAttachment(java.lang.String listId,
                                           int itemId,
                                           java.lang.String fileName,
                                           byte[] buffer)
                                    throws ServiceException

Creates the list item attachment.

Parameters:: listId -; itemId -; fileName -; buffer -
Returns:
Throws:: ServiceException

createListItemAttachment

public Attachment createListItemAttachment(java.lang.String listId,
                                           int itemId,
                                           java.lang.String fileName,
                                           java.io.InputStream stream)
                                    throws ServiceException

Creates the list item attachment.

Parameters:: listId -; itemId -; fileName -; stream -
Returns:
Throws:: ServiceException

createRole
```
public Role createRole(Role role)
                throws ServiceException
```
Creates the role.

Parameters:

role - the role

Returns:

the role

Throws:

ServiceException - the service exception

createSite
```
public Site createSite(SiteCreationInfo siteInfo)
                throws ServiceException
```
Creates the site.

Parameters:

siteInfo - the site info

Returns:

the site

Throws:

ServiceException - the service exception

createTemplateFile
```
public File createTemplateFile(java.lang.String filePath)
                        throws ServiceException
```
Creates the template file.

Parameters:

filePath - the file path

Returns:

the file

Throws:

ServiceException - the service exception

createTemplateFile

public File createTemplateFile(java.lang.String filePath,
                               TemplateFileType type)
                        throws ServiceException

Creates the template file.

Parameters:: filePath - the file path; type - the type
Returns:: the file
Throws:: ServiceException - the service exception

createUser
```
public User createUser(User user,
                       int groupId)
                throws ServiceException
```
Creates the user.

Parameters:

user - the user

groupId - the group id

Returns:

the user

Throws:

ServiceException - the service exception

createView

public View createView(java.lang.String listId,
                       View view)
                throws ServiceException

Creates the view.

Parameters:: listId - the list id; view - the view
Returns:: the view
Throws:: ServiceException - the service exception

createViewField

public boolean createViewField(java.lang.String listId,
                               java.lang.String viewId,
                               java.lang.String fieldName)
                        throws ServiceException

Creates the view field.

Parameters:: listId - the list id; viewId - the view id; fieldName - the field name
Returns:: true, if successful
Throws:: ServiceException - the service exception

deleteAllFileVersions
```
public boolean deleteAllFileVersions(java.lang.String filePath)
                              throws ServiceException
```
Delete all file versions.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

deleteAllViewFields

public boolean deleteAllViewFields(java.lang.String listId,
                                   java.lang.String viewId)
                            throws ServiceException

Delete all view fields.

Parameters:: listId - the list id; viewId - the view id
Returns:: true, if successful
Throws:: ServiceException - the service exception

deleteField

public void deleteField(java.lang.String id,
                        java.lang.String listId)
                 throws ServiceException

Delete field.

Parameters:: id - the id; listId - the list id
Throws:: ServiceException - the service exception

deleteFile
```
public void deleteFile(java.lang.String filePath)
                throws ServiceException
```
Delete file.

Parameters:

filePath - the file path

Throws:

ServiceException - the service exception

deleteFileVersion
```
public boolean deleteFileVersion(java.lang.String filePath,
                                 int versionId)
                          throws ServiceException
```
Delete file version.

Parameters:

filePath - the file path

versionId - the version id

Returns:

true, if successful

Throws:

ServiceException - the service exception

deleteFileVersion

public boolean deleteFileVersion(java.lang.String filePath,
                                 java.lang.String versionLabel)
                          throws ServiceException

Delete file version.

Parameters:: filePath - the file path; versionLabel - the version label
Returns:: true, if successful
Throws:: ServiceException - the service exception

deleteFolder
```
public void deleteFolder(java.lang.String folderPath)
                  throws ServiceException
```
Delete folder.

Parameters:

folderPath - the folder path

Throws:

ServiceException - the service exception

deleteGroup
```
public boolean deleteGroup(int groupId)
                    throws ServiceException
```
Delete group.

Parameters:

groupId - the group id

Returns:

true, if successful

Throws:

ServiceException - the service exception

deleteGroup
```
public boolean deleteGroup(java.lang.String loginName)
                    throws ServiceException
```
Delete group.

Parameters:

loginName - the login name

Returns:

true, if successful

Throws:

ServiceException - the service exception

deleteList
```
public void deleteList(java.lang.String listId)
                throws ServiceException
```
Delete list.

Parameters:

listId - the list id

Throws:

ServiceException - the service exception

deleteListItem

public void deleteListItem(java.lang.String listId,
                           int itemId)
                    throws ServiceException

Delete list item.

Parameters:: listId - the list id; itemId - the item id
Throws:: ServiceException - the service exception

deleteRole
```
public void deleteRole(int roleId)
                throws ServiceException
```
Delete role.

Parameters:

roleId - the role id

Throws:

ServiceException - the service exception

deleteSite
```
public void deleteSite()
                throws ServiceException
```
Delete site.

Throws:

ServiceException - the service exception

deleteUser
```
public boolean deleteUser(int userId,
                          int groupId)
                   throws ServiceException
```
Delete user.

Parameters:

userId - the user id

groupId - the group id

Returns:

true, if successful

Throws:

ServiceException - the service exception

deleteUser
```
public boolean deleteUser(java.lang.String loginName,
                          int groupId)
                   throws ServiceException
```
Delete user.

Parameters:

loginName - the login name

groupId - the group id

Returns:

true, if successful

Throws:

ServiceException - the service exception

deleteView

public void deleteView(java.lang.String listId,
                       java.lang.String viewId)
                throws ServiceException

Delete view.

Parameters:: listId - the list id; viewId - the view id
Throws:: ServiceException - the service exception

deleteViewField

public boolean deleteViewField(java.lang.String listId,
                               java.lang.String viewId,
                               java.lang.String fieldName)
                        throws ServiceException

Delete view field.

Parameters:: listId - the list id; viewId - the view id; fieldName - the field name
Returns:: true, if successful
Throws:: ServiceException - the service exception

deny
```
public boolean deny(java.lang.String filePath)
             throws ServiceException
```
Deny.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

deny
```
public boolean deny(java.lang.String filePath,
                    java.lang.String comment)
             throws ServiceException
```
Deny.

Parameters:

filePath - the file path

comment - the comment

Returns:

true, if successful

Throws:

ServiceException - the service exception

ensureUser
```
public User ensureUser(java.lang.String loginName)
                throws ServiceException
```
Ensure user.

Parameters:

loginName - the login name

Returns:

the user

Throws:

ServiceException - the service exception

getAssociatedMemberGroup
```
public Group getAssociatedMemberGroup()
                               throws ServiceException
```
Gets the associated member group.

Returns:

the associated member group

Throws:

ServiceException - the service exception

getAssociatedOwnerGroup
```
public Group getAssociatedOwnerGroup()
                              throws ServiceException
```
Gets the associated owner group.

Returns:

the associated owner group

Throws:

ServiceException - the service exception

getAssociatedVisitorGroup
```
public Group getAssociatedVisitorGroup()
                                throws ServiceException
```
Gets the associated visitor group.

Returns:

the associated visitor group

Throws:

ServiceException - the service exception

getAuthorizationCode

public java.lang.String getAuthorizationCode()

getAuthorizationCodeRedirectUri

public java.lang.String getAuthorizationCodeRedirectUri()

getAuthorizationCodeRequestUri

public java.lang.String getAuthorizationCodeRequestUri(java.lang.String redirectUri)

getAuthorizationCodeRequestUri

public java.lang.String getAuthorizationCodeRequestUri(java.lang.String redirectUri,
                                                       java.lang.String responseMode)

getAuthorizationCodeRequestUri

public java.lang.String getAuthorizationCodeRequestUri(java.lang.String redirectUri,
                                                       java.lang.String responseMode,
                                                       java.lang.String state)

getAvailableContentTypes

public java.util.List<ContentType> getAvailableContentTypes()
                                                     throws ServiceException

Gets the available content types.

Returns:: the available content types
Throws:: ServiceException - the service exception

getAvailableContentTypes

public java.util.List<ContentType> getAvailableContentTypes(java.util.List<IQueryOption> queryOptions)
                                                     throws ServiceException

Gets the available content types.

Parameters:: queryOptions - the query options
Returns:: the available content types
Throws:: ServiceException - the service exception

getCatalog
```
public List getCatalog(ListTemplateType listTemplate)
                throws ServiceException
```
Gets the catalog.

Parameters:

listTemplate - the list template

Returns:

the catalog

Throws:

ServiceException - the service exception

getChanges

public java.util.List<Change> getChanges(ChangeQuery query)
                                  throws ServiceException

Gets the changes.

Parameters:: query - the query
Returns:: the changes
Throws:: ServiceException - the service exception

getChanges

public java.util.List<Change> getChanges(ChangeQuery query,
                                         java.util.List<IQueryOption> queryOptions)
                                  throws ServiceException

Gets the changes.

Parameters:: query - the query; queryOptions - the query options
Returns:: the changes
Throws:: ServiceException - the service exception

getChanges

public java.util.List<Change> getChanges(ChangeQuery query,
                                         java.lang.String listId)
                                  throws ServiceException

Gets the changes.

Parameters:: query - the query; listId - the list id
Returns:: the changes
Throws:: ServiceException - the service exception

getChanges

public java.util.List<Change> getChanges(ChangeQuery query,
                                         java.lang.String listId,
                                         java.util.List<IQueryOption> queryOptions)
                                  throws ServiceException

Gets the changes.

Parameters:: query - the query; listId - the list id; queryOptions - the query options
Returns:: the changes
Throws:: ServiceException - the service exception

getClientAssertion

public java.lang.String getClientAssertion()

getClientConnectionManager
```
public org.apache.http.conn.HttpClientConnectionManager getClientConnectionManager()
```
Gets connection manager.

Returns:

the client connection manager

getClientId
```
public java.lang.String getClientId()
```

getClientSecret

public java.lang.String getClientSecret()

getConnectTimeout
```
public int getConnectTimeout()
```
Returns setting for connect timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).

Returns:

the connect timeout

getContentType
```
public ContentType getContentType(java.lang.String contentTypeId)
                           throws ServiceException
```
Gets the content type.

Parameters:

contentTypeId - the content type id

Returns:

the content type

Throws:

ServiceException - the service exception

getContentType

public ContentType getContentType(java.lang.String listId,
                                  java.lang.String contentTypeId)
                           throws ServiceException

Gets the content type.

Parameters:: listId - the list id; contentTypeId - the content type id
Returns:: the content type
Throws:: ServiceException - the service exception

getContentTypeFieldLinks
```
public java.util.List<FieldLink> getContentTypeFieldLinks(java.lang.String contentTypeId)
                                                   throws ServiceException
```
Gets the content type field links.

Parameters:

contentTypeId - the content type id

Returns:

the content type field links

Throws:

ServiceException - the service exception

getContentTypeFieldLinks

public java.util.List<FieldLink> getContentTypeFieldLinks(java.lang.String contentTypeId,
                                                          java.util.List<IQueryOption> queryOptions)
                                                   throws ServiceException

Gets the content type field links.

Parameters:: contentTypeId - the content type id; queryOptions - the query options
Returns:: the content type field links
Throws:: ServiceException - the service exception

getContentTypeFieldLinks

public java.util.List<FieldLink> getContentTypeFieldLinks(java.lang.String listId,
                                                          java.lang.String contentTypeId)
                                                   throws ServiceException

Gets the content type field links.

Parameters:: listId - the list id; contentTypeId - the content type id
Returns:: the content type field links
Throws:: ServiceException - the service exception

getContentTypeFieldLinks

public java.util.List<FieldLink> getContentTypeFieldLinks(java.lang.String listId,
                                                          java.lang.String contentTypeId,
                                                          java.util.List<IQueryOption> queryOptions)
                                                   throws ServiceException

Gets the content type field links.

Parameters:: listId - the list id; contentTypeId - the content type id; queryOptions - the query options
Returns:: the content type field links
Throws:: ServiceException - the service exception

getContentTypeFields
```
public java.util.List<Field> getContentTypeFields(java.lang.String contentTypeId)
                                           throws ServiceException
```
Gets the content type fields.

Parameters:

contentTypeId - the content type id

Returns:

the content type fields

Throws:

ServiceException - the service exception

getContentTypeFields

public java.util.List<Field> getContentTypeFields(java.lang.String contentTypeId,
                                                  java.util.List<IQueryOption> queryOptions)
                                           throws ServiceException

Gets the content type fields.

Parameters:: contentTypeId - the content type id; queryOptions - the query options
Returns:: the content type fields
Throws:: ServiceException - the service exception

getContentTypeFields

public java.util.List<Field> getContentTypeFields(java.lang.String listId,
                                                  java.lang.String contentTypeId)
                                           throws ServiceException

Gets the content type fields.

Parameters:: listId - the list id; contentTypeId - the content type id
Returns:: the content type fields
Throws:: ServiceException - the service exception

getContentTypeFields

public java.util.List<Field> getContentTypeFields(java.lang.String listId,
                                                  java.lang.String contentTypeId,
                                                  java.util.List<IQueryOption> queryOptions)
                                           throws ServiceException

Gets the content type fields.

Parameters:: listId - the list id; contentTypeId - the content type id; queryOptions - the query options
Returns:: the content type fields
Throws:: ServiceException - the service exception

getContentTypes

public java.util.List<ContentType> getContentTypes()
                                            throws ServiceException

Gets the content types.

Returns:: the content types
Throws:: ServiceException - the service exception

getContentTypes

public java.util.List<ContentType> getContentTypes(java.lang.String listId)
                                            throws ServiceException

Gets the content types.

Parameters:: listId - the list id
Returns:: the content types
Throws:: ServiceException - the service exception

getContentTypes

public java.util.List<ContentType> getContentTypes(java.lang.String listId,
                                                   java.util.List<IQueryOption> queryOptions)
                                            throws ServiceException

Gets the content types.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the content types
Throws:: ServiceException - the service exception

getContextInfo
```
public ContextInfo getContextInfo()
                           throws ServiceException
```
Gets the context info.

Returns:

the context info

Throws:

ServiceException - the service exception

getCreatedByUser
```
public User getCreatedByUser(java.lang.String filePath,
                             int versionId)
                      throws ServiceException
```
Gets the created by user.

Parameters:

filePath - the file path

versionId - the version id

Returns:

the created by user

Throws:

ServiceException - the service exception

getCurrentUser
```
public User getCurrentUser()
                    throws ServiceException
```
Gets the current user.

Returns:

the current user

Throws:

ServiceException - the service exception

getCustomHeaders

public org.apache.http.Header[] getCustomHeaders()

getCustomListTemplates

public java.util.List<ListTemplate> getCustomListTemplates()
                                                    throws ServiceException

Gets the custom list templates.

Returns:: the custom list templates
Throws:: ServiceException - the service exception

getCustomListTemplates

public java.util.List<ListTemplate> getCustomListTemplates(java.util.List<IQueryOption> queryOptions)
                                                    throws ServiceException

Gets the custom list templates.

Parameters:: queryOptions - the query options
Returns:: the custom list templates
Throws:: ServiceException - the service exception

getDeviceAuthorizationCode

public DeviceAuthorizationCode getDeviceAuthorizationCode()
                                                   throws ServiceException

Throws:: ServiceException

getDeviceCode

public java.lang.String getDeviceCode()

getDomain
```
public java.lang.String getDomain()
```
Gets user's domain.

Returns:

the domain

getEffectiveBasePermissions

public java.util.List<BasePermission> getEffectiveBasePermissions()
                                                           throws ServiceException

Gets the effective base permissions.

Returns:: the effective base permissions
Throws:: ServiceException - the service exception

getEventReceiver
```
public EventReceiver getEventReceiver(java.lang.String receiverId)
                               throws ServiceException
```
Gets the event receiver.

Parameters:

receiverId - the receiver id

Returns:

the event receiver

Throws:

ServiceException - the service exception

getEventReceivers

public java.util.List<EventReceiver> getEventReceivers()
                                                throws ServiceException

Gets the event receivers.

Returns:: the event receivers
Throws:: ServiceException - the service exception

getEventReceivers

public java.util.List<EventReceiver> getEventReceivers(java.util.List<IQueryOption> queryOptions)
                                                throws ServiceException

Gets the event receivers.

Parameters:: queryOptions - the query options
Returns:: the event receivers
Throws:: ServiceException - the service exception

getFeatures

public java.util.List<java.lang.String> getFeatures()
                                             throws ServiceException

Gets the features.

Returns:: the features
Throws:: ServiceException - the service exception

getFeatures

public java.util.List<java.lang.String> getFeatures(java.util.List<IQueryOption> queryOptions)
                                             throws ServiceException

Gets the features.

Parameters:: queryOptions - the query options
Returns:: the features
Throws:: ServiceException - the service exception

getField
```
public Field getField(java.lang.String id)
               throws ServiceException
```
Gets the field.

Parameters:

id - the id

Returns:

the field

Throws:

ServiceException - the service exception

getField

public Field getField(java.lang.String id,
                      java.lang.String listId)
               throws ServiceException

Gets the field.

Parameters:: id - the id; listId - the list id
Returns:: the field
Throws:: ServiceException - the service exception

getFieldByInternalNameOrTitle
```
public Field getFieldByInternalNameOrTitle(java.lang.String name)
                                    throws ServiceException
```
Gets the field by internal name or title.

Parameters:

name - the name

Returns:

the field by internal name or title

Throws:

ServiceException - the service exception

getFieldByInternalNameOrTitle
```
public Field getFieldByInternalNameOrTitle(java.lang.String name,
                                           java.lang.String listId)
                                    throws ServiceException
```
Gets the field by internal name or title.

Parameters:

name - the name

listId - the list id

Returns:

the field by internal name or title

Throws:

ServiceException - the service exception

getFieldByTitle
```
public Field getFieldByTitle(java.lang.String title)
                      throws ServiceException
```
Gets the field by title.

Parameters:

title - the title

Returns:

the field by title

Throws:

ServiceException - the service exception

getFieldByTitle

public Field getFieldByTitle(java.lang.String title,
                             java.lang.String listId)
                      throws ServiceException

Gets the field by title.

Parameters:: title - the title; listId - the list id
Returns:: the field by title
Throws:: ServiceException - the service exception

getFields

public java.util.List<Field> getFields()
                                throws ServiceException

Gets the fields.

Returns:: the fields
Throws:: ServiceException - the service exception

getFields

public java.util.List<Field> getFields(java.util.List<IQueryOption> queryOptions)
                                throws ServiceException

Gets the fields.

Parameters:: queryOptions - the query options
Returns:: the fields
Throws:: ServiceException - the service exception

getFieldValues

public java.util.List<FieldValue> getFieldValues(java.lang.String listId,
                                                 int itemId)
                                          throws ServiceException

Gets the field values.

Parameters:: listId - the list id; itemId - the item id
Returns:: the field values
Throws:: ServiceException - the service exception

getFieldValues

public java.util.List<FieldValue> getFieldValues(java.lang.String listId,
                                                 int itemId,
                                                 java.util.List<IQueryOption> queryOptions)
                                          throws ServiceException

Gets the field values.

Parameters:: listId - the list id; itemId - the item id; queryOptions - the query options
Returns:: the field values
Throws:: ServiceException - the service exception

getFieldValuesAsHtml

public java.util.List<FieldValue> getFieldValuesAsHtml(java.lang.String listId,
                                                       int itemId)
                                                throws ServiceException

Gets the field values.

Parameters:: listId - the list id; itemId - the item id
Returns:: the field values
Throws:: ServiceException - the service exception

getFieldValuesAsHtml

public java.util.List<FieldValue> getFieldValuesAsHtml(java.lang.String listId,
                                                       int itemId,
                                                       java.util.List<IQueryOption> queryOptions)
                                                throws ServiceException

Gets the field values.

Parameters:: listId - the list id; itemId - the item id; queryOptions - the query options
Returns:: the field values
Throws:: ServiceException - the service exception

getFile
```
public File getFile(java.lang.String filePath)
             throws ServiceException
```
Gets the file.

Parameters:

filePath - the file path

Returns:

the file

Throws:

ServiceException - the service exception

getFileAuthor
```
public User getFileAuthor(java.lang.String filePath)
                   throws ServiceException
```
Gets the file author.

Parameters:

filePath - the file path

Returns:

the file author

Throws:

ServiceException - the service exception

getFileByRelativePath

public File getFileByRelativePath(java.lang.String filePath)
                           throws ServiceException

Throws:: ServiceException

getFileContent
```
public byte[] getFileContent(java.lang.String filePath)
                      throws ServiceException
```
Gets the file content.

Parameters:

filePath - the file path

Returns:

the file content

Throws:

ServiceException - the service exception

getFileFieldValues

public java.util.List<FieldValue> getFileFieldValues(java.lang.String filePath)
                                              throws ServiceException

Gets the field values.

Parameters:: filePath - the file path
Returns:: the field values
Throws:: ServiceException - the service exception

getFileFieldValues

public java.util.List<FieldValue> getFileFieldValues(java.lang.String filePath,
                                                     java.util.List<IQueryOption> queryOptions)
                                              throws ServiceException

Gets the field values.

Parameters:: filePath - the file path; queryOptions - the query options
Returns:: the field values
Throws:: ServiceException - the service exception

getFileLinks
```
public java.util.List<Link> getFileLinks(java.lang.String filePath)
                                  throws ServiceException
```
Gets the list item links.

Parameters:

filePath - the file path

Returns:

the links

Throws:

ServiceException - the service exception

getFileListItemInfo

public ListItemInfo getFileListItemInfo(java.lang.String filePath)
                                 throws ServiceException

Gets the list id and item id of the file.

Parameters:: filePath -
Returns:: the ListItemInfo
Throws:: ServiceException

getFiles
```
public java.util.List<File> getFiles(java.lang.String folderPath)
                              throws ServiceException
```
Gets the files.

Parameters:

folderPath - the folder path

Returns:

the files

Throws:

ServiceException - the service exception

getFiles

public java.util.List<File> getFiles(java.lang.String folderPath,
                                     java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the files.

Parameters:: folderPath - the folder path; queryOptions - the query options
Returns:: the files
Throws:: ServiceException - the service exception

getFileStream
```
public java.io.InputStream getFileStream(java.lang.String filePath)
                                  throws ServiceException
```
Gets the file stream.

Parameters:

filePath - the file path

Returns:

the file stream

Throws:

ServiceException - the service exception

getFileStreamByRelativePath

public java.io.InputStream getFileStreamByRelativePath(java.lang.String filePath)
                                                throws ServiceException

Gets the file stream.

Parameters:: filePath - the file path
Returns:: the file stream
Throws:: ServiceException - the service exception

getFileVersion

public FileVersion getFileVersion(java.lang.String filePath,
                                  int versionId)
                           throws ServiceException

Gets the file version.

Parameters:: filePath - the file path; versionId - the version id
Returns:: the file version
Throws:: ServiceException - the service exception

getFileVersions

public java.util.List<FileVersion> getFileVersions(java.lang.String filePath)
                                            throws ServiceException

Gets the file versions.

Parameters:: filePath - the file path
Returns:: the file versions
Throws:: ServiceException - the service exception

getFileVersions

public java.util.List<FileVersion> getFileVersions(java.lang.String filePath,
                                                   java.util.List<IQueryOption> queryOptions)
                                            throws ServiceException

Gets the file versions.

Parameters:: filePath - the file path; queryOptions - the query options
Returns:: the file versions
Throws:: ServiceException - the service exception

getFolder
```
public Folder getFolder(java.lang.String folderPath)
                 throws ServiceException
```
Gets the folder.

Parameters:

folderPath - the folder path

Returns:

the folder

Throws:

ServiceException - the service exception

getFolderFieldValues

public java.util.List<FieldValue> getFolderFieldValues(java.lang.String folderPath)
                                                throws ServiceException

Gets the field values.

Parameters:: folderPath - the file path
Returns:: the field values
Throws:: ServiceException - the service exception

getFolderFieldValues

public java.util.List<FieldValue> getFolderFieldValues(java.lang.String folderPath,
                                                       java.util.List<IQueryOption> queryOptions)
                                                throws ServiceException

Gets the field values.

Parameters:: folderPath - the folder path; queryOptions - the query options
Returns:: the field values
Throws:: ServiceException - the service exception

getFolderLinks
```
public java.util.List<Link> getFolderLinks(java.lang.String folderPath)
                                    throws ServiceException
```
Gets the folder links.

Parameters:

folderPath - the folder path

Returns:

the links

Throws:

ServiceException - the service exception

getFolderListItemInfo

public ListItemInfo getFolderListItemInfo(java.lang.String folderPath)
                                   throws ServiceException

Gets the list id and item id of the folder.

Parameters:: folderPath -
Returns:: the ListItemInfo
Throws:: ServiceException

getFolders
```
public java.util.List<Folder> getFolders(java.lang.String parentFolder)
                                  throws ServiceException
```
Gets the folders.

Parameters:

parentFolder - the parent folder

Returns:

the folders

Throws:

ServiceException - the service exception

getFolders

public java.util.List<Folder> getFolders(java.lang.String parentFolder,
                                         java.util.List<IQueryOption> queryOptions)
                                  throws ServiceException

Gets the folders.

Parameters:: parentFolder - the parent folder; queryOptions - the query options
Returns:: the folders
Throws:: ServiceException - the service exception

getGroup
```
public Group getGroup(int groupId)
               throws ServiceException
```
Gets the group.

Parameters:

groupId - the group id

Returns:

the group

Throws:

ServiceException - the service exception

getGroup
```
public Group getGroup(java.lang.String loginName)
               throws ServiceException
```
Gets the group.

Parameters:

loginName - the login name

Returns:

the group

Throws:

ServiceException - the service exception

getGroupOwner
```
public User getGroupOwner(int groupId)
                   throws ServiceException
```
Gets the group owner.

Parameters:

groupId - the group id

Returns:

the group owner

Throws:

ServiceException - the service exception

getGroupOwner
```
public User getGroupOwner(java.lang.String loginName)
                   throws ServiceException
```
Gets the group owner.

Parameters:

loginName - the login name

Returns:

the group owner

Throws:

ServiceException - the service exception

getGroups

public java.util.List<Group> getGroups()
                                throws ServiceException

Gets the groups.

Returns:: the groups
Throws:: ServiceException - the service exception

getGroups

public java.util.List<Group> getGroups(java.util.List<IQueryOption> queryOptions)
                                throws ServiceException

Gets the groups.

Parameters:: queryOptions - the query options
Returns:: the groups
Throws:: ServiceException - the service exception

getGroupUsers
```
public java.util.List<User> getGroupUsers(int groupId)
                                   throws ServiceException
```
Gets the group users.

Parameters:

groupId - the group id

Returns:

the group users

Throws:

ServiceException - the service exception

getGroupUsers

public java.util.List<User> getGroupUsers(int groupId,
                                          java.util.List<IQueryOption> queryOptions)
                                   throws ServiceException

Gets the group users.

Parameters:: groupId - the group id; queryOptions - the query options
Returns:: the group users
Throws:: ServiceException - the service exception

getGroupUsers
```
public java.util.List<User> getGroupUsers(java.lang.String loginName)
                                   throws ServiceException
```
Gets the group users.

Parameters:

loginName - the login name

Returns:

the group users

Throws:

ServiceException - the service exception

getGroupUsers

public java.util.List<User> getGroupUsers(java.lang.String loginName,
                                          java.util.List<IQueryOption> queryOptions)
                                   throws ServiceException

Gets the group users.

Parameters:: loginName - the login name; queryOptions - the query options
Returns:: the group users
Throws:: ServiceException - the service exception

getHttpURLConnectionProxy
```
public java.net.Proxy getHttpURLConnectionProxy()
```
Gets HttpURLConnection proxy server.

Returns:

the http url connection proxy

getInputStream
```
public java.io.InputStream getInputStream(java.lang.String url)
                                   throws ServiceException
```
Gets the input stream.

Parameters:

url - the url

Returns:

the input stream

Throws:

ServiceException - the service exception

getLimitedWebPartManager
```
public LimitedWebPartManager getLimitedWebPartManager(java.lang.String filePath)
                                               throws ServiceException
```
Gets the limited web part manager.

Parameters:

filePath - the file path

Returns:

the limited web part manager

Throws:

ServiceException - the service exception

getLimitedWebPartManager

public LimitedWebPartManager getLimitedWebPartManager(java.lang.String filePath,
                                                      PersonalizationScope scope)
                                               throws ServiceException

Gets the limited web part manager.

Parameters:: filePath - the file path; scope - the scope
Returns:: the limited web part manager
Throws:: ServiceException - the service exception

getList
```
public List getList(java.lang.String listId)
             throws ServiceException
```
Gets the list.

Parameters:

listId - the list id

Returns:

the list

Throws:

ServiceException - the service exception

getListByTitle
```
public List getListByTitle(java.lang.String title)
                    throws ServiceException
```
Gets the list by title.

Parameters:

title - the title

Returns:

the list by title

Throws:

ServiceException - the service exception

getListContentTypes

public java.util.List<ContentType> getListContentTypes(java.lang.String listId)
                                                throws ServiceException

Gets the list content types.

Parameters:: listId - the list id
Returns:: the list content types
Throws:: ServiceException - the service exception

getListContentTypes

public java.util.List<ContentType> getListContentTypes(java.lang.String listId,
                                                       java.util.List<IQueryOption> queryOptions)
                                                throws ServiceException

Gets the list content types.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the list content types
Throws:: ServiceException - the service exception

getListDefaultView
```
public View getListDefaultView(java.lang.String listId)
                        throws ServiceException
```
Gets the list default view.

Parameters:

listId - the list id

Returns:

the list default view

Throws:

ServiceException - the service exception

getListEventReceivers

public java.util.List<EventReceiver> getListEventReceivers(java.lang.String listId)
                                                    throws ServiceException

Gets the list event receivers.

Parameters:: listId - the list id
Returns:: the list event receivers
Throws:: ServiceException - the service exception

getListEventReceivers

public java.util.List<EventReceiver> getListEventReceivers(java.lang.String listId,
                                                           java.util.List<IQueryOption> queryOptions)
                                                    throws ServiceException

Gets the list event receivers.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the list event receivers
Throws:: ServiceException - the service exception

getListFields
```
public java.util.List<Field> getListFields(java.lang.String listId)
                                    throws ServiceException
```
Gets the list fields.

Parameters:

listId - the list id

Returns:

the list fields

Throws:

ServiceException - the service exception

getListFields

public java.util.List<Field> getListFields(java.lang.String listId,
                                           java.util.List<IQueryOption> queryOptions)
                                    throws ServiceException

Gets the list fields.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the list fields
Throws:: ServiceException - the service exception

getListForm

public Form getListForm(java.lang.String listId,
                        java.lang.String formId)
                 throws ServiceException

Gets the list form.

Parameters:: listId - the list id; formId - the form id
Returns:: the list form
Throws:: ServiceException - the service exception

getListForms
```
public java.util.List<Form> getListForms(java.lang.String listId)
                                  throws ServiceException
```
Gets the list forms.

Parameters:

listId - the list id

Returns:

the list forms

Throws:

ServiceException - the service exception

getListForms

public java.util.List<Form> getListForms(java.lang.String listId,
                                         java.util.List<IQueryOption> queryOptions)
                                  throws ServiceException

Gets the list forms.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the list forms
Throws:: ServiceException - the service exception

getListItem

public ListItem getListItem(java.lang.String listId,
                            int itemId)
                     throws ServiceException

Gets the list item.

Parameters:: listId - the list id; itemId - the item id
Returns:: the list item
Throws:: ServiceException - the service exception

getListItemAttachments

public java.util.List<Attachment> getListItemAttachments(java.lang.String listId,
                                                         int itemId)
                                                  throws ServiceException

Gets the list item attachments.

Parameters:: listId - the list id; itemId - the item id
Returns:: the list item attachments
Throws:: ServiceException - the service exception

getListItemAttachments

public java.util.List<Attachment> getListItemAttachments(java.lang.String listId,
                                                         int itemId,
                                                         java.util.List<IQueryOption> queryOptions)
                                                  throws ServiceException

Gets the list item attachments.

Parameters:: listId - the list id; itemId - the item id; queryOptions - the query options
Returns:: the list item attachments
Throws:: ServiceException - the service exception

getListItemChanges

public java.util.List<Change> getListItemChanges(java.lang.String listId,
                                                 ChangeLogItemQuery query)
                                          throws ServiceException

Gets the list item changes.

Parameters:: listId - the list id; query - the query
Returns:: the list item changes
Throws:: ServiceException - the service exception

getListItemChanges

public java.util.List<Change> getListItemChanges(java.lang.String listId,
                                                 ChangeLogItemQuery query,
                                                 java.util.List<IQueryOption> queryOptions)
                                          throws ServiceException

Gets the list item changes.

Parameters:: listId - the list id; query - the query; queryOptions - the query options
Returns:: the list item changes
Throws:: ServiceException - the service exception

getListItemContentType

public ContentType getListItemContentType(java.lang.String listId,
                                          int itemId)
                                   throws ServiceException

Gets the list item content type.

Parameters:: listId - the list id; itemId - the item id
Returns:: the list item content type
Throws:: ServiceException - the service exception

getListItemLinks
```
public java.util.List<Link> getListItemLinks(java.lang.String filePath)
                                      throws ServiceException
```
Gets the list item links.

Parameters:

filePath - the file path

Returns:

the links

Throws:

ServiceException - the service exception

getListItemProperty

public java.lang.String getListItemProperty(java.lang.String listId,
                                            int itemId,
                                            java.lang.String propertyName)
                                     throws ServiceException

Gets the list item property as xml string.

Parameters:: listId - the list id; itemId - the item id; propertyName - the property name
Returns:: the list item
Throws:: ServiceException - the service exception

getListItems

public java.util.List<ListItem> getListItems(java.lang.String listId)
                                      throws ServiceException

Gets the list items.

Parameters:: listId - the list id
Returns:: the list items
Throws:: ServiceException - the service exception

getListItems

public java.util.List<ListItem> getListItems(java.lang.String listId,
                                             java.util.List<IQueryOption> queryOptions)
                                      throws ServiceException

Gets the list items.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the list items
Throws:: ServiceException - the service exception

getListRegionalSettings
```
public RegionalSettings getListRegionalSettings(java.lang.String listId)
                                         throws ServiceException
```
Gets the list regional settings.

Parameters:

listId - the list id

Returns:

the list regional settings

Throws:

ServiceException - the service exception

getLists

public java.util.List<List> getLists()
                              throws ServiceException

Gets the lists.

Returns:: the lists
Throws:: ServiceException - the service exception

getLists

public java.util.List<List> getLists(java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the lists.

Parameters:: queryOptions - the query options
Returns:: the lists
Throws:: ServiceException - the service exception

getListSchemaXml
```
public java.lang.String getListSchemaXml(java.lang.String listId)
                                  throws ServiceException
```
Gets the list schema xml.

Parameters:

listId - the list id

Returns:

the list schema xml

Throws:

ServiceException - the service exception

getListServerSettings
```
public ServerSettings getListServerSettings(java.lang.String listId)
                                     throws ServiceException
```
Gets the list server settings.

Parameters:

listId - the list id

Returns:

the list server settings

Throws:

ServiceException - the service exception

getListTemplate
```
public ListTemplate getListTemplate(java.lang.String name)
                             throws ServiceException
```
Gets the list template.

Parameters:

name - the name

Returns:

the list template

Throws:

ServiceException - the service exception

getListTemplates

public java.util.List<ListTemplate> getListTemplates()
                                              throws ServiceException

Gets the list templates.

Returns:: the list templates
Throws:: ServiceException - the service exception

getListTemplates

public java.util.List<ListTemplate> getListTemplates(java.util.List<IQueryOption> queryOptions)
                                              throws ServiceException

Gets the list templates.

Parameters:: queryOptions - the query options
Returns:: the list templates
Throws:: ServiceException - the service exception

getLockedByUser
```
public User getLockedByUser(java.lang.String filePath)
                     throws ServiceException
```
Gets the locked by user.

Parameters:

filePath - the file path

Returns:

the locked by user

Throws:

ServiceException - the service exception

getLoginHostUri
```
public java.lang.String getLoginHostUri()
```
Gets login host uri. Default is "https://login.microsoftonline.com"

Returns:

the Microsoft Graph login host uri

getModifiedByUser
```
public User getModifiedByUser(java.lang.String filePath)
                       throws ServiceException
```
Gets the modified by user.

Parameters:

filePath - the file path

Returns:

the modified by user

Throws:

ServiceException - the service exception

getNavigationNode
```
public NavigationNode getNavigationNode(int id)
                                 throws ServiceException
```
Gets the navigation node.

Parameters:

id - the id

Returns:

the navigation node

Throws:

ServiceException - the service exception

getNavigationNodeChildren
```
public java.util.List<NavigationNode> getNavigationNodeChildren(int id)
                                                         throws ServiceException
```
Gets the navigation node children.

Parameters:

id - the id

Returns:

the navigation node children

Throws:

ServiceException - the service exception

getNavigationNodeChildren

public java.util.List<NavigationNode> getNavigationNodeChildren(int id,
                                                                java.util.List<IQueryOption> queryOptions)
                                                         throws ServiceException

Gets the navigation node children.

Parameters:: id - the id; queryOptions - the query options
Returns:: the navigation node children
Throws:: ServiceException - the service exception

getOAuthToken
```
public OAuthToken getOAuthToken()
```

getOAuthTokenWithAuthorizationCode

public OAuthToken getOAuthTokenWithAuthorizationCode(java.lang.String authorizationCode,
                                                     java.lang.String authorizationCodeRedirectUri)
                                              throws ServiceException

Throws:: ServiceException

getOAuthTokenWithAuthorizationCode

public OAuthToken getOAuthTokenWithAuthorizationCode(java.lang.String authorizationCode,
                                                     java.lang.String authorizationCodeRedirectUri,
                                                     java.lang.String clientSecret)
                                              throws ServiceException

Throws:: ServiceException

getOAuthTokenWithClientAssertion

public OAuthToken getOAuthTokenWithClientAssertion(java.lang.String clientAssertion)
                                            throws ServiceException

Throws:: ServiceException

getOAuthTokenWithClientSecret

public OAuthToken getOAuthTokenWithClientSecret(java.lang.String clientSecret)
                                         throws ServiceException

Throws:: ServiceException

getOAuthTokenWithDeviceAuthorizationCode

public OAuthToken getOAuthTokenWithDeviceAuthorizationCode(java.lang.String deviceCode)
                                                    throws ServiceException

Throws:: ServiceException

getOAuthTokenWithUsernamePassword

public OAuthToken getOAuthTokenWithUsernamePassword(java.lang.String username,
                                                    java.lang.String password)
                                             throws ServiceException

Throws:: ServiceException

getOAuthTokenWithUsernamePassword

public OAuthToken getOAuthTokenWithUsernamePassword(java.lang.String username,
                                                    java.lang.String password,
                                                    java.lang.String clientSecret)
                                             throws ServiceException

Throws:: ServiceException

getOAuthTokenWithUsernamePassword

public OAuthToken getOAuthTokenWithUsernamePassword(java.lang.String username,
                                                    java.lang.String password,
                                                    java.lang.String clientSecret,
                                                    java.lang.String clientAssertion)
                                             throws ServiceException

Throws:: ServiceException

getPassword
```
public java.lang.String getPassword()
```
Gets user's password.

Returns:

the password

getProxy
```
public org.apache.http.HttpHost getProxy()
```
Gets HttpClient proxy.

Returns:

the proxy

getProxyCredentials
```
public org.apache.http.auth.Credentials getProxyCredentials()
```
Gets proxy credentials.

Returns:

the proxy credentials

getQuickLaunch

public java.util.List<NavigationNode> getQuickLaunch()
                                              throws ServiceException

Gets the quick launch.

Returns:: the quick launch
Throws:: ServiceException - the service exception

getQuickLaunch

public java.util.List<NavigationNode> getQuickLaunch(java.util.List<IQueryOption> queryOptions)
                                              throws ServiceException

Gets the quick launch.

Parameters:: queryOptions - the query options
Returns:: the quick launch
Throws:: ServiceException - the service exception

getReadTimeout
```
public int getReadTimeout()
```
Returns setting for read timeout. 0 return implies that the option is disabled (i.e., timeout of infinity).

Returns:

the read timeout

getRealmInfo

public RealmInfo getRealmInfo()
                       throws java.lang.Exception

Throws:: java.lang.Exception

getRecycleBinItem
```
public RecycleBinItem getRecycleBinItem(java.lang.String id)
                                 throws ServiceException
```
Gets the recycle bin item.

Parameters:

id - the id

Returns:

the recycle bin item

Throws:

ServiceException - the service exception

getRecycleBinItemAuthor
```
public User getRecycleBinItemAuthor(java.lang.String id)
                             throws ServiceException
```
Gets the recycle bin item author.

Parameters:

id - the id

Returns:

the recycle bin item author

Throws:

ServiceException - the service exception

getRecycleBinItemDeletedBy
```
public User getRecycleBinItemDeletedBy(java.lang.String id)
                                throws ServiceException
```
Gets the recycle bin item deleted by.

Parameters:

id - the id

Returns:

the recycle bin item deleted by

Throws:

ServiceException - the service exception

getRecycleBinItems

public java.util.List<RecycleBinItem> getRecycleBinItems()
                                                  throws ServiceException

Gets the recycle bin items.

Returns:: the recycle bin items
Throws:: ServiceException - the service exception

getRecycleBinItems

public java.util.List<RecycleBinItem> getRecycleBinItems(java.util.List<IQueryOption> queryOptions)
                                                  throws ServiceException

Gets the recycle bin items.

Parameters:: queryOptions - the query options
Returns:: the recycle bin items
Throws:: ServiceException - the service exception

getRegionalSettings
```
public RegionalSettings getRegionalSettings()
                                     throws ServiceException
```
Gets the regional settings.

Returns:

the regional settings

Throws:

ServiceException - the service exception

getRelatedFields
```
public java.util.List<Field> getRelatedFields(java.lang.String listId)
                                       throws ServiceException
```
Gets the related fields.

Parameters:

listId - the list id

Returns:

the related fields

Throws:

ServiceException - the service exception

getRelatedFields

public java.util.List<Field> getRelatedFields(java.lang.String listId,
                                              java.util.List<IQueryOption> queryOptions)
                                       throws ServiceException

Gets the related fields.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the related fields
Throws:: ServiceException - the service exception

getRequestConfig
```
public org.apache.http.client.config.RequestConfig getRequestConfig()
```
Gets request configuration.

Returns:

the request configuration

getRequestHttpHeaders

public java.util.List<HttpHeader> getRequestHttpHeaders()

getResponseHttpHeaders

public java.util.List<HttpHeader> getResponseHttpHeaders()

getRole
```
public Role getRole(int roleId)
             throws ServiceException
```
Gets the role.

Parameters:

roleId - the role id

Returns:

the role

Throws:

ServiceException - the service exception

getRole
```
public Role getRole(RoleType type)
             throws ServiceException
```
Gets the role.

Parameters:

type - the type

Returns:

the role

Throws:

ServiceException - the service exception

getRole
```
public Role getRole(java.lang.String name)
             throws ServiceException
```
Gets the role.

Parameters:

name - the name

Returns:

the role

Throws:

ServiceException - the service exception

getRoleAssignments

public java.util.List<java.lang.Integer> getRoleAssignments()
                                                     throws ServiceException

Gets the role assignments.

Returns:: the role assignments
Throws:: ServiceException - the service exception

getRoleAssignments
```
public java.util.List<java.lang.Integer> getRoleAssignments(int principalId)
                                                     throws ServiceException
```
Gets the role assignments.

Parameters:

principalId - the principal id

Returns:

the role assignments

Throws:

ServiceException - the service exception

getRoleAssignments

public java.util.List<java.lang.Integer> getRoleAssignments(java.util.List<IQueryOption> queryOptions)
                                                     throws ServiceException

Gets the role assignments.

Parameters:: queryOptions - the query options
Returns:: the role assignments
Throws:: ServiceException - the service exception

getRoles

public java.util.List<Role> getRoles()
                              throws ServiceException

Gets the roles.

Returns:: the roles
Throws:: ServiceException - the service exception

getRoles

public java.util.List<Role> getRoles(java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the roles.

Parameters:: queryOptions - the query options
Returns:: the roles
Throws:: ServiceException - the service exception

getRootFolder
```
public Folder getRootFolder()
                     throws ServiceException
```
Gets the root folder.

Returns:

the root folder

Throws:

ServiceException - the service exception

getScope

public java.util.List<java.lang.String> getScope()

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType,
                                            java.lang.String responseMode)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType,
                                            java.lang.String responseMode,
                                            java.lang.String state)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType,
                                            java.lang.String responseMode,
                                            java.lang.String state,
                                            java.lang.String nonce)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType,
                                            java.lang.String responseMode,
                                            java.lang.String state,
                                            java.lang.String nonce,
                                            java.lang.String loginHint)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType,
                                            java.lang.String responseMode,
                                            java.lang.String state,
                                            java.lang.String nonce,
                                            java.lang.String loginHint,
                                            java.lang.String domainHint)

getSignInRequestUri

public java.lang.String getSignInRequestUri(java.lang.String redirectUri,
                                            java.lang.String responseType,
                                            java.lang.String responseMode,
                                            java.lang.String state,
                                            java.lang.String nonce,
                                            java.lang.String loginHint,
                                            java.lang.String domainHint,
                                            java.lang.String prompt)

getSite
```
public Site getSite()
             throws ServiceException
```
Gets the site.

Returns:

the site

Throws:

ServiceException - the service exception

getSiteInfos

public java.util.List<SiteInfo> getSiteInfos()
                                      throws ServiceException

Gets the site infos.

Returns:: the site infos
Throws:: ServiceException - the service exception

getSiteInfos

public java.util.List<SiteInfo> getSiteInfos(java.util.List<IQueryOption> queryOptions)
                                      throws ServiceException

Gets the site infos.

Parameters:: queryOptions - the query options
Returns:: the site infos
Throws:: ServiceException - the service exception

getSites

public java.util.List<Site> getSites()
                              throws ServiceException

Gets the sites.

Returns:: the sites
Throws:: ServiceException - the service exception

getSites

public java.util.List<Site> getSites(java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the sites.

Parameters:: queryOptions - the query options
Returns:: the sites
Throws:: ServiceException - the service exception

getSiteTemplates

public java.util.List<SiteTemplate> getSiteTemplates(Locale locale)
                                              throws ServiceException

Gets the site templates.

Parameters:: locale - the locale
Returns:: the site templates
Throws:: ServiceException - the service exception

getSiteTemplates

public java.util.List<SiteTemplate> getSiteTemplates(Locale locale,
                                                     boolean includeCrossLanguage)
                                              throws ServiceException

Gets the site templates.

Parameters:: locale - the locale; includeCrossLanguage - the include cross language
Returns:: the site templates
Throws:: ServiceException - the service exception

getSiteTemplates

public java.util.List<SiteTemplate> getSiteTemplates(Locale locale,
                                                     boolean includeCrossLanguage,
                                                     java.util.List<IQueryOption> queryOptions)
                                              throws ServiceException

Gets the site templates.

Parameters:: locale - the locale; includeCrossLanguage - the include cross language; queryOptions - the query options
Returns:: the site templates
Throws:: ServiceException - the service exception

getSiteTemplates

public java.util.List<SiteTemplate> getSiteTemplates(Locale locale,
                                                     java.util.List<IQueryOption> queryOptions)
                                              throws ServiceException

Gets the site templates.

Parameters:: locale - the locale; queryOptions - the query options
Returns:: the site templates
Throws:: ServiceException - the service exception

getSiteUrl
```
public java.lang.String getSiteUrl()
```
Gets SharePoint site url.

Returns:

getTenant
```
public java.lang.String getTenant()
```

getThemeInfo
```
public ThemeInfo getThemeInfo()
                       throws ServiceException
```
Gets the theme info.

Returns:

the theme info

Throws:

ServiceException - the service exception

getTimeZone
```
public TimeZone getTimeZone()
                     throws ServiceException
```
Gets the time zone.

Returns:

the time zone

Throws:

ServiceException - the service exception

getTimeZones

public java.util.List<TimeZone> getTimeZones()
                                      throws ServiceException

Gets the time zones.

Returns:: the time zones
Throws:: ServiceException - the service exception

getTimeZones

public java.util.List<TimeZone> getTimeZones(java.util.List<IQueryOption> queryOptions)
                                      throws ServiceException

Gets the time zones.

Parameters:: queryOptions - the query options
Returns:: the time zones
Throws:: ServiceException - the service exception

getTopNavigationBar

public java.util.List<NavigationNode> getTopNavigationBar()
                                                   throws ServiceException

Gets the top navigation bar.

Returns:: the top navigation bar
Throws:: ServiceException - the service exception

getTopNavigationBar

public java.util.List<NavigationNode> getTopNavigationBar(java.util.List<IQueryOption> queryOptions)
                                                   throws ServiceException

Gets the top navigation bar.

Parameters:: queryOptions - the query options
Returns:: the top navigation bar
Throws:: ServiceException - the service exception

getUser
```
public User getUser(int userId)
             throws ServiceException
```
Gets the user.

Parameters:

userId - the user id

Returns:

the user

Throws:

ServiceException - the service exception

getUser
```
public User getUser(int userId,
                    int groupId)
             throws ServiceException
```
Gets the user.

Parameters:

userId - the user id

groupId - the group id

Returns:

the user

Throws:

ServiceException - the service exception

getUser
```
public User getUser(java.lang.String loginName,
                    int groupId)
             throws ServiceException
```
Gets the user.

Parameters:

loginName - the login name

groupId - the group id

Returns:

the user

Throws:

ServiceException - the service exception

getUserAgent
```
public java.lang.String getUserAgent()
```
Gets the User-Agent.

Returns:

the User-Agent

getUserByEmail
```
public User getUserByEmail(java.lang.String email,
                           int groupId)
                    throws ServiceException
```
Gets the user by email.

Parameters:

email - the email

groupId - the group id

Returns:

the user by email

Throws:

ServiceException - the service exception

getUserCustomActions
```
public java.util.List<Role> getUserCustomActions()
                                          throws ServiceException
```
Gets the user custom actions.

Returns:

the user custom actions

Throws:

ServiceException - the service exception

getUserCustomActions
```
public java.util.List<Role> getUserCustomActions(java.util.List<IQueryOption> queryOptions)
                                          throws ServiceException
```
Gets the user custom actions.

Parameters:

queryOptions - the query options

Returns:

the user custom actions

Throws:

ServiceException - the service exception

getUserEffectivePermissions

public java.util.List<BasePermission> getUserEffectivePermissions(java.lang.String listId,
                                                                  int itemId,
                                                                  java.lang.String loginName)
                                                           throws ServiceException

Gets the user effective permissions.

Parameters:: listId - the list id; itemId - the item id; loginName - the login name
Returns:: the user effective permissions
Throws:: ServiceException - the service exception

getUserEffectivePermissions

public java.util.List<BasePermission> getUserEffectivePermissions(java.lang.String listId,
                                                                  java.lang.String loginName)
                                                           throws ServiceException

Gets the user effective permissions.

Parameters:: listId - the list id; loginName - the login name
Returns:: the user effective permissions
Throws:: ServiceException - the service exception

getUserGroups
```
public java.util.List<Group> getUserGroups(int userId)
                                    throws ServiceException
```
Gets the user groups.

Parameters:

userId - the user id

Returns:

the user groups

Throws:

ServiceException - the service exception

getUserGroups

public java.util.List<Group> getUserGroups(int userId,
                                           java.util.List<IQueryOption> queryOptions)
                                    throws ServiceException

Gets the user groups.

Parameters:: userId - the user id; queryOptions - the query options
Returns:: the user groups
Throws:: ServiceException - the service exception

getUserInfoList
```
public List getUserInfoList()
                     throws ServiceException
```
Gets the user info list.

Returns:

the user info list

Throws:

ServiceException - the service exception

getUsername
```
public java.lang.String getUsername()
```
Gets username.

Returns:

the username

getUsers

public java.util.List<User> getUsers()
                              throws ServiceException

Gets the users.

Returns:: the users
Throws:: ServiceException - the service exception

getUsers
```
public java.util.List<User> getUsers(int groupId)
                              throws ServiceException
```
Gets the users.

Parameters:

groupId - the group id

Returns:

the users

Throws:

ServiceException - the service exception

getUsers

public java.util.List<User> getUsers(int groupId,
                                     java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the users.

Parameters:: groupId - the group id; queryOptions - the query options
Returns:: the users
Throws:: ServiceException - the service exception

getUsers

public java.util.List<User> getUsers(java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the users.

Parameters:: queryOptions - the query options
Returns:: the users
Throws:: ServiceException - the service exception

getView

public View getView(java.lang.String listId,
                    java.lang.String viewId)
             throws ServiceException

Gets the view.

Parameters:: listId - the list id; viewId - the view id
Returns:: the view
Throws:: ServiceException - the service exception

getViewByTitle

public View getViewByTitle(java.lang.String listId,
                           java.lang.String title)
                    throws ServiceException

Gets the view by title.

Parameters:: listId - the list id; title - the title
Returns:: the view by title
Throws:: ServiceException - the service exception

getViewFields

public java.util.List<java.lang.String> getViewFields(java.lang.String listId,
                                                      java.lang.String viewId)
                                               throws ServiceException

Gets the view fields.

Parameters:: listId - the list id; viewId - the view id
Returns:: the view fields
Throws:: ServiceException - the service exception

getViewFields

public java.util.List<java.lang.String> getViewFields(java.lang.String listId,
                                                      java.lang.String viewId,
                                                      java.util.List<IQueryOption> queryOptions)
                                               throws ServiceException

Gets the view fields.

Parameters:: listId - the list id; viewId - the view id; queryOptions - the query options
Returns:: the view fields
Throws:: ServiceException - the service exception

getViewFieldsSchemaXml

public java.lang.String getViewFieldsSchemaXml(java.lang.String listId,
                                               java.lang.String viewId)
                                        throws ServiceException

Gets the view fields schema xml.

Parameters:: listId - the list id; viewId - the view id
Returns:: the view fields schema xml
Throws:: ServiceException - the service exception

getViewHtml

public java.lang.String getViewHtml(java.lang.String listId,
                                    java.lang.String viewId)
                             throws ServiceException

Gets the view html.

Parameters:: listId - the list id; viewId - the view id
Returns:: the view html
Throws:: ServiceException - the service exception

getViews

public java.util.List<View> getViews(java.lang.String listId)
                              throws ServiceException

Gets the views.

Parameters:: listId - the list id
Returns:: the views
Throws:: ServiceException - the service exception

getViews

public java.util.List<View> getViews(java.lang.String listId,
                                     java.util.List<IQueryOption> queryOptions)
                              throws ServiceException

Gets the views.

Parameters:: listId - the list id; queryOptions - the query options
Returns:: the views
Throws:: ServiceException - the service exception

getWorkflowTemplates

public java.util.List<WorkflowTemplate> getWorkflowTemplates()
                                                      throws ServiceException

Gets the workflow templates.

Returns:: the workflow templates
Throws:: ServiceException - the service exception

getWorkflowTemplates

public java.util.List<WorkflowTemplate> getWorkflowTemplates(java.util.List<IQueryOption> queryOptions)
                                                      throws ServiceException

Gets the workflow templates.

Parameters:: queryOptions - the query options
Returns:: the workflow templates
Throws:: ServiceException - the service exception

isAcceptGzipEncoding
```
public boolean isAcceptGzipEncoding()
```
Return whether to accept GZIP encoding, that is, whether to send the HTTP "Accept-Encoding" header with "gzip" as value.

Returns:

true, if is accept gzip encoding

isSharedNavigation
```
public boolean isSharedNavigation()
                           throws ServiceException
```
Checks if is shared navigation.

Returns:

true, if is shared navigation

Throws:

ServiceException - the service exception

loginAdfs

public java.lang.String loginAdfs()
                           throws java.lang.Exception

Throws:: java.lang.Exception

moveFile
```
public boolean moveFile(java.lang.String sourceFilePath,
                        java.lang.String destinationFilePath)
                 throws ServiceException
```
Move file.

Parameters:

sourceFilePath - the source file path

destinationFilePath - the destination file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

moveFile

public boolean moveFile(java.lang.String sourceFilePath,
                        java.lang.String destinationFilePath,
                        MoveOperation operation)
                 throws ServiceException

Move file.

Parameters:: sourceFilePath - the source file path; destinationFilePath - the destination file path; operation - the operation
Returns:: true, if successful
Throws:: ServiceException - the service exception

moveViewField

public boolean moveViewField(java.lang.String listId,
                             java.lang.String viewId,
                             java.lang.String fieldName,
                             int index)
                      throws ServiceException

Move view field.

Parameters:: listId - the list id; viewId - the view id; fieldName - the field name; index - the index
Returns:: true, if successful
Throws:: ServiceException - the service exception

publish
```
public boolean publish(java.lang.String filePath)
                throws ServiceException
```
Publish.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

publish

public boolean publish(java.lang.String filePath,
                       java.lang.String comment)
                throws ServiceException

Publish.

Parameters:: filePath - the file path; comment - the comment
Returns:: true, if successful
Throws:: ServiceException - the service exception

recycleFile
```
public java.lang.String recycleFile(java.lang.String filePath)
                             throws ServiceException
```
Recycle file.

Parameters:

filePath - the file path

Returns:

the string

Throws:

ServiceException - the service exception

recycleFolder
```
public java.lang.String recycleFolder(java.lang.String folderPath)
                               throws ServiceException
```
Recycle folder.

Parameters:

folderPath - the folder path

Returns:

the string

Throws:

ServiceException - the service exception

recycleList
```
public java.lang.String recycleList(java.lang.String listId)
                             throws ServiceException
```
Recycle list.

Parameters:

listId - the list id

Returns:

the string

Throws:

ServiceException - the service exception

recycleListItem

public java.lang.String recycleListItem(java.lang.String listId,
                                        int itemId)
                                 throws ServiceException

Recycle list item.

Parameters:: listId - the list id; itemId - the item id
Returns:: the string
Throws:: ServiceException - the service exception

refreshOAuthToken

public OAuthToken refreshOAuthToken()
                             throws ServiceException

Throws:: ServiceException

refreshOAuthToken

public OAuthToken refreshOAuthToken(java.lang.String clientId,
                                    java.lang.String tenant,
                                    java.lang.String refreshToken)
                             throws ServiceException

Throws:: ServiceException

refreshOAuthToken

public OAuthToken refreshOAuthToken(java.lang.String clientId,
                                    java.lang.String tenant,
                                    java.lang.String refreshToken,
                                    java.util.List<java.lang.String> scope)
                             throws ServiceException

Throws:: ServiceException

refreshOAuthToken

public OAuthToken refreshOAuthToken(java.lang.String clientId,
                                    java.lang.String tenant,
                                    java.lang.String refreshToken,
                                    java.util.List<java.lang.String> scope,
                                    java.lang.String clientSecret)
                             throws ServiceException

Throws:: ServiceException

removeRoleAssignment
```
public boolean removeRoleAssignment(int principalId,
                                    int roleId)
                             throws ServiceException
```
Removes the role assignment.

Parameters:

principalId - the principal id

roleId - the role id

Returns:

true, if successful

Throws:

ServiceException - the service exception

renameFile

public void renameFile(java.lang.String filePath,
                       java.lang.String newName)
                throws ServiceException

Renames file.

Parameters:: filePath - the file path; newName - the new folder name.
Throws:: ServiceException

renameFolder

public void renameFolder(java.lang.String folderPath,
                         java.lang.String newName)
                  throws ServiceException

Renames folder.

Parameters:: folderPath - the folder path; newName - the new folder name.
Throws:: ServiceException

renderListData

public java.lang.String renderListData(java.lang.String listId,
                                       java.lang.String viewXml)
                                throws ServiceException

Render list data.

Parameters:: listId - the list id; viewXml - the view xml
Returns:: the string
Throws:: ServiceException - the service exception

renderListFormData

public java.lang.String renderListFormData(java.lang.String listId,
                                           int itemId,
                                           java.lang.String formId,
                                           ControlMode mode)
                                    throws ServiceException

Render list form data.

Parameters:: listId - the list id; itemId - the item id; formId - the form id; mode - the mode
Returns:: the string
Throws:: ServiceException - the service exception

reserveListItemId
```
public int reserveListItemId(java.lang.String listId)
                      throws ServiceException
```
Reserve list item id.

Parameters:

listId - the list id

Returns:

the int

Throws:

ServiceException - the service exception

resetRoleInheritance

public boolean resetRoleInheritance(java.lang.String listId,
                                    int itemId)
                             throws ServiceException

Reset role inheritance.

Parameters:: listId - the list id; itemId - the item id
Returns:: true, if successful
Throws:: ServiceException - the service exception

restoreFileVersion

public boolean restoreFileVersion(java.lang.String filePath,
                                  java.lang.String versionLabel)
                           throws ServiceException

Restore file version.

Parameters:: filePath - the file path; versionLabel - the version label
Returns:: true, if successful
Throws:: ServiceException - the service exception

search
```
public SearchResult search(IRestriction restriction)
                    throws ServiceException
```
Search.

Parameters:

restriction - the restriction

Returns:

the search result

Throws:

ServiceException - the service exception

search
```
public SearchResult search(IRestriction restriction)
                    throws ServiceException
```
Search.

Parameters:

restriction - the restriction

Returns:

the search result

Throws:

ServiceException - the service exception

search
```
public SearchResult search(SearchQuery query)
                    throws ServiceException
```
Search.

Parameters:

query - the query

Returns:

the search result

Throws:

ServiceException - the service exception

search
```
public SearchResult search(java.lang.String query)
                    throws ServiceException
```
Search.

Parameters:

query - the query

Returns:

the search result

Throws:

ServiceException - the service exception

setAcceptGzipEncoding
```
public void setAcceptGzipEncoding(boolean acceptGzipEncoding)
```
Set whether to accept GZIP encoding, that is, whether to send the HTTP "Accept-Encoding" header with "gzip" as value.

Parameters:

acceptGzipEncoding - the new accept gzip encoding

setAuthorizationCode

public void setAuthorizationCode(java.lang.String authorizationCode)

setAuthorizationCodeRedirectUri

public void setAuthorizationCodeRedirectUri(java.lang.String authorizationCodeRedirectUri)

setclientAssertion

public void setclientAssertion(java.lang.String clientAssertion)

setClientConnectionManager
```
public void setClientConnectionManager(org.apache.http.conn.HttpClientConnectionManager connectionManager)
```
Sets connection manager.

Parameters:

connectionManager - the new client connection manager

setClientId

public void setClientId(java.lang.String clientId)

setClientSecret

public void setClientSecret(java.lang.String clientSecret)

setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
Sets the specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by the HttpURLConnection. If the timeout expires before the connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Parameters:

connectTimeout - the new connect timeout

setCustomHeaders

public void setCustomHeaders(org.apache.http.Header[] customHeaders)

setDeviceCode

public void setDeviceCode(java.lang.String deviceCode)

setDomain
```
public void setDomain(java.lang.String domain)
```
Sets user's domain.

Parameters:

domain - the new domain

setFieldValue

public void setFieldValue(java.lang.String listId,
                          int listItemId,
                          FieldValue fieldValue)
                   throws ServiceException

Sets the field value.

Parameters:: listId - the list id; listItemId - the list item id; fieldValue - the field value
Throws:: ServiceException - the service exception

setFieldValues

public void setFieldValues(java.lang.String listId,
                           int listItemId,
                           java.util.List<FieldValue> fieldValues)
                    throws ServiceException

Sets the field values.

Parameters:: listId - the list id; listItemId - the list item id; fieldValues - the field values
Throws:: ServiceException - the service exception

setFileFieldValue

public void setFileFieldValue(java.lang.String filePath,
                              FieldValue fieldValue)
                       throws ServiceException

Sets the field value.

Parameters:: filePath - the file path; fieldValues - the field values
Throws:: ServiceException - the service exception

setFileFieldValues

public void setFileFieldValues(java.lang.String filePath,
                               java.util.List<FieldValue> fieldValues)
                        throws ServiceException

Sets the field values.

Parameters:: filePath - the file path; fieldValues - the field values
Throws:: ServiceException - the service exception

setFolderFieldValue

public void setFolderFieldValue(java.lang.String folderPath,
                                FieldValue fieldValue)
                         throws ServiceException

Set the folder field value.

Parameters:: folderPath - the folder path; fieldValues - the field values
Throws:: ServiceException - the service exception

setFolderFieldValues

public void setFolderFieldValues(java.lang.String folderPath,
                                 java.util.List<FieldValue> fieldValues)
                          throws ServiceException

Set the folder field values.

Parameters:: folderPath - the folder path; fieldValues - the field values
Throws:: ServiceException - the service exception

setHttpURLConnection
```
public void setHttpURLConnection(boolean useHttpURLConnection)
```
Sets the http url connection.

Parameters:

useHttpURLConnection - the new http url connection

setHttpURLConnectionProxy
```
public void setHttpURLConnectionProxy(java.net.Proxy httpURLConnectionProxy)
```
Sets HttpURLConnection proxy server.

Parameters:

httpURLConnectionProxy - the new http url connection proxy

setLoginHostUri
```
public void setLoginHostUri(java.lang.String loginHostUri)
```
Sets login host uri. Default is "https://login.microsoftonline.com"

Parameters:

loginHostUri - the the Microsoft Graph login host uri

setOAuthToken

public void setOAuthToken(OAuthToken oAuthToken)

setPassword
```
public void setPassword(java.lang.String password)
```
Sets user's password.

Parameters:

password - the new password

setProxy
```
public void setProxy(org.apache.http.HttpHost proxy)
```
Sets HttpClient proxy.

Parameters:

proxy - the new proxy

setProxyCredentials
```
public void setProxyCredentials(org.apache.http.auth.Credentials proxyCredentials)
```
Sets proxy credentials.

Parameters:

proxyCredentials - the new proxy credentials

setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
Sets the read timeout to the specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Parameters:

readTimeout - the new read timeout

setRequestConfig
```
public void setRequestConfig(org.apache.http.client.config.RequestConfig requestConfig)
```
Sets request configuration.

Parameters:

requestConfig - the request configuration

setShowInDisplayForm

public boolean setShowInDisplayForm(java.lang.String id,
                                    java.lang.String listId)
                             throws ServiceException

Sets the show in display form.

Parameters:: id - the id; listId - the list id
Returns:: true, if successful
Throws:: ServiceException - the service exception

setShowInDisplayForm

public boolean setShowInDisplayForm(java.lang.String id,
                                    java.lang.String listId,
                                    boolean show)
                             throws ServiceException

Sets the show in display form.

Parameters:: id - the id; listId - the list id; show - the show
Returns:: true, if successful
Throws:: ServiceException - the service exception

setShowInEditForm

public boolean setShowInEditForm(java.lang.String id,
                                 java.lang.String listId)
                          throws ServiceException

Sets the show in edit form.

Parameters:: id - the id; listId - the list id
Returns:: true, if successful
Throws:: ServiceException - the service exception

setShowInEditForm

public boolean setShowInEditForm(java.lang.String id,
                                 java.lang.String listId,
                                 boolean show)
                          throws ServiceException

Sets the show in edit form.

Parameters:: id - the id; listId - the list id; show - the show
Returns:: true, if successful
Throws:: ServiceException - the service exception

setShowInNewForm

public boolean setShowInNewForm(java.lang.String id,
                                java.lang.String listId)
                         throws ServiceException

Sets the show in new form.

Parameters:: id - the id; listId - the list id
Returns:: true, if successful
Throws:: ServiceException - the service exception

setShowInNewForm

public boolean setShowInNewForm(java.lang.String id,
                                java.lang.String listId,
                                boolean show)
                         throws ServiceException

Sets the show in new form.

Parameters:: id - the id; listId - the list id; show - the show
Returns:: true, if successful
Throws:: ServiceException - the service exception

setSiteUrl
```
public void setSiteUrl(java.lang.String siteUrl)
```
Sets SharePoint site url.

Parameters:

siteUrl -

setTenant

public void setTenant(java.lang.String tenant)

setUserAgent
```
public void setUserAgent(java.lang.String userAgent)
```
Sets the User-Agent.

Parameters:

userAgent - the User-Agent

setUsername
```
public void setUsername(java.lang.String username)
```
Sets username.

Parameters:

username - the new username

suggest
```
public SuggestResult suggest(SearchQuerySuggestion suggestion)
                      throws ServiceException
```
Suggest.

Parameters:

suggestion - the suggestion

Returns:

the suggest result

Throws:

ServiceException - the service exception

suggest
```
public SuggestResult suggest(java.lang.String query)
                      throws ServiceException
```
Suggest.

Parameters:

query - the query

Returns:

the suggest result

Throws:

ServiceException - the service exception

undoCheckOut
```
public boolean undoCheckOut(java.lang.String filePath)
                     throws ServiceException
```
Undo check out.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

unpublish
```
public boolean unpublish(java.lang.String filePath)
                  throws ServiceException
```
Unpublish.

Parameters:

filePath - the file path

Returns:

true, if successful

Throws:

ServiceException - the service exception

unpublish

public boolean unpublish(java.lang.String filePath,
                         java.lang.String comment)
                  throws ServiceException

Unpublish.

Parameters:: filePath - the file path; comment - the comment
Returns:: true, if successful
Throws:: ServiceException - the service exception

updateField

public Field updateField(Field field,
                         java.lang.String listId)
                  throws ServiceException

Update field.

Parameters:: field - the field; listId - the list id
Returns:: the field
Throws:: ServiceException - the service exception

updateFileContent

public void updateFileContent(java.lang.String filePath,
                              byte[] buffer)
                       throws ServiceException

Update file content.

Parameters:: filePath - the file path; buffer - the buffer
Throws:: ServiceException - the service exception

updateFileContent

public void updateFileContent(java.lang.String filePath,
                              java.io.InputStream stream)
                       throws ServiceException

Update file content.

Parameters:: filePath - the file path; stream - the stream
Throws:: ServiceException - the service exception

updateFolder
```
public void updateFolder(Folder folder)
                  throws ServiceException
```
Update folder.

Parameters:

folder - the folder

Throws:

ServiceException - the service exception

updateGroup
```
public void updateGroup(Group group)
                 throws ServiceException
```
Update group.

Parameters:

group - the group

Throws:

ServiceException - the service exception

updateList
```
public void updateList(List list)
                throws ServiceException
```
Update list.

Parameters:

list - the list

Throws:

ServiceException - the service exception

updateListItem

public void updateListItem(java.lang.String listId,
                           ListItem listItem)
                    throws ServiceException

Update list item.

Parameters:: listId - the list id; listItem - the list item
Throws:: ServiceException - the service exception

updateListItemAttachment

public void updateListItemAttachment(java.lang.String listId,
                                     int itemId,
                                     java.lang.String fileName,
                                     byte[] buffer)
                              throws ServiceException

Updates the list item attachment.

Parameters:: listId -; itemId -; fileName -; buffer -
Throws:: ServiceException

updateListItemAttachment

public void updateListItemAttachment(java.lang.String listId,
                                     int itemId,
                                     java.lang.String fileName,
                                     java.io.InputStream stream)
                              throws ServiceException

Updates the list item attachment.

Parameters:: listId -; itemId -; fileName -; stream -
Throws:: ServiceException

updateRole
```
public void updateRole(Role role)
                throws ServiceException
```
Update role.

Parameters:

role - the role

Throws:

ServiceException - the service exception

updateSite
```
public void updateSite(Site site)
                throws ServiceException
```
Update site.

Parameters:

site - the site

Throws:

ServiceException - the service exception

updateUser
```
public User updateUser(User user,
                       int groupId)
                throws ServiceException
```
Update user.

Parameters:

user - the user

groupId - the group id

Returns:

the user

Throws:

ServiceException - the service exception

updateView

public void updateView(java.lang.String listId,
                       View view)
                throws ServiceException

Update view.

Parameters:: listId - the list id; view - the view
Throws:: ServiceException - the service exception

uploadFile
```
public long uploadFile(java.lang.String filePath,
                       java.io.InputStream inputStream)
                throws ServiceException
```
Uploads large file.

Parameters:

filePath - The file path

inputStream - The stream to upload

Returns:

Size of uploaded data in bytes

Throws:

ServiceException

uploadFile
```
public long uploadFile(java.lang.String filePath,
                       java.io.InputStream inputStream,
                       java.lang.String uploadId)
                throws ServiceException
```
Uploads large file.

Parameters:

filePath - The file path

inputStream - The stream to upload

uploadId - Upload ID (GUID). Set it if you want to cancel upload with method cancelUploadFile.

Returns:

Size of uploaded data in bytes

Throws:

ServiceException

Class Service

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Service

Service

Service

Service

Method Detail

addDependentLookupField

addRoleAssignment

applySiteTemplate

applyTheme

applyTheme

applyTheme

applyTheme

applyTheme

applyTheme

approve

approve

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

breakRoleInheritance

cancelUploadFile

checkedOutByUser

checkIn

checkIn

checkIn

checkIn

checkOut

copyFile

copyFile

createField

createField

createField

createField

createField

createFile

createFile

createFile

createFile

createFolder

createGroup

createList

createListItem

createListItemAttachment

createListItemAttachment

createListItemAttachment

createRole

createSite

createTemplateFile

createTemplateFile

createUser

createView

createViewField

deleteAllFileVersions

deleteAllViewFields

deleteField

deleteFile

deleteFileVersion

deleteFileVersion

deleteFolder

deleteGroup

deleteGroup

deleteList

deleteListItem

deleteRole

deleteSite

deleteUser

deleteUser

deleteView

deleteViewField

deny