<dependency>
<groupId>com.groupdocs</groupId>
<artifactId>groupdocs-annotation-cloud</artifactId>
<version>23.12</version>
</dependency>
compile(group: 'com.groupdocs', name: 'groupdocs-annotation-cloud', version: '23.12')
<dependency org="com.groupdocs" name="groupdocs-annotation-cloud" rev="23.12">
<artifact name="groupdocs-annotation-cloud" ext="jar"/>
</dependency>
libraryDependencies += "com.groupdocs" % "groupdocs-annotation-cloud" % "23.12"
文档注释Java云REST API
GroupDocs.Annotation Cloud SDK for Java 帮助您构建无需安装任何第三方软件的云文档注释Java应用程序。它是 GroupDocs.Annotation Cloud REST API 的包装器。
文档注释功能
- 向云文档添加单个或多个注释。
- 直接向存储在云中的文档添加注释。
- 支持各种注释类型,包括文本、图像和形状。
- 自定义注释属性,如颜色、大小和位置。
- 为多个文档格式添加注释,如PDF、Word、Excel、PowerPoint和图像。
文档管理功能
- 渲染文档: 将文档转换为PDF、图像或HTML格式以供查看或打印。
- 预览文档: 生成文档页面的图像表示以供预览。
- 删除注释: 删除特定注释或从文档中删除所有注释。
- 提取注释: 将文档中的所有注释作为JSON对象列表提取。
文件与存储管理
- 使用文件API: 上传、下载、复制、移动和删除云存储中的文件。
- 使用文件夹API: 组织和管理云存储中的文件夹(创建、移动、删除)。
- 使用存储API: 访问和管理云存储资源,包括检索存储详情和文件信息。
- 获取支持的文件格式: 检索支持注释的文件格式列表。
- 文件信息: 获取云中文件的详细信息,如大小、格式和元数据。
文档信息与处理
- 获取文档信息: 检索详细的文档信息,包括元数据、文本内容和注释。
- 获取页面: 访问文档中的页面列表以及页面大小和方向等详细信息。
- 注释信息: 访问注释的详细信息,包括类型、位置和内容。
- 注释选项: 配置各种注释选项,包括页面选择、位置和样式。
- 高级用法: 使用高级功能管理注释,如分组和排序。
支持的注释类型
- 区域注释: 突出显示和注释云文档中的特定矩形区域。
- 箭头注释: 画箭头指向云文档页面上的特定内容。
- 距离注释: 测量并注释云文档中两个对象或点之间的距离。
- 椭圆注释: 使用椭圆形突出显示和注释文档中的特定内容。
- 图像注释: 在文档内容上叠加图像作为注释。
- 链接注释: 添加链接到外部资源的超链接注释。
- 点注释: 在文档中指定的点上放置注释。
- 折线注释: 绘制自由曲线或形状以注释和突出显示内容。
- 资源编辑注释: 用黑色矩形覆盖以编辑敏感文本。
- 文本字段注释: 在带有彩色框架的注释中添加文本评论。
- 文本高亮注释: 高亮文本并添加评论以引起对特定内容的关注。
- 文本编辑注释: 用黑色矩形隐藏选定文本以进行编辑。
- 文本替换注释: 通过注释替换原始文本为新片段。
- 文本删除线注释: 用删除线标记文本以表示删除。
- 文本下划线注释: 在文本下划线并添加注释以强调。
- 水印注释: 在文档上添加水印文本注释。
- 波浪线注释: 使用波浪线在文本下划线并引起注意。
API特定功能
- 直接添加注释: 无需下载文档即可直接添加注释。
- 公开API示例: 访问示例代码和文档以使用API功能。
支持的云注释文档格式
- Microsoft Word®: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, TXT
- OpenOffice Writer®: ODT, OTT
- Microsoft Excel®: XLS, XLSX, XLSB
- Microsoft PowerPoint®: PPT, PPTX, PPSX
- OpenOffice Impress®: ODP, OTP
- Microsoft Visio®: VSD, VDX, VSS, VSDM
- Microsoft Outlook®: MSG, EML, EMLX
- AutoCAD®: CAD
- 图像: DJVU, JPEG, TIFF, BMP, GIF (静态图像无动画)
- 医学影像: DICOM
- 标记语言: HTML, MHTML
- 固定布局: PDF
- 元文件: EMF, WMF
系统要求
- Java版本: 构建API客户端库需要Java 1.7+。
- 构建工具: Maven用于管理依赖项并构建项目。
前提条件
- GroupDocs Cloud账户: 要使用GroupDocs.Annotation Cloud SDK for Java,您需要在 GroupDocs Cloud 注册一个账户。
- 客户端ID和客户端密钥: 注册后,您需要在 Cloud Dashboard 上查找或创建您的客户端ID和客户端密钥。
- 免费配额: GroupDocs Cloud 为新用户提供免费配额。有关更多详情,您应查看 GroupDocs Cloud Pricing。
从Maven安装GroupDocs.Annotation-Cloud
要安装GroupDocs.Annotation Cloud SDK for Java,您需要将GroupDocs Cloud存储库添加到应用程序的 pom.xml
文件中:
<repository>
<id>repository.groupdocs.cloud</id>
<name>repository.groupdocs.cloud</name>
<url>https://releases.groupdocs.cloud/java/repo/</url>
</repository>
从源代码安装
要从源代码安装API客户端库,请按照以下步骤操作:
- 安装到本地Maven存储库: 要将库安装到您的本地Maven存储库,只需在终端中执行以下命令:
mvn clean install
- 部署到远程Maven存储库: 如果您希望将其部署到远程Maven存储库,请配置存储库设置并执行以下命令:
mvn clean deploy
有关部署到远程存储库的更多详情,请参考 OSSRH Guide。
Maven用户
如果您是Maven用户,可以在项目的 pom.xml
文件中将GroupDocs.Annotation Cloud SDK for Java添加为依赖项:
<dependency>
<groupId>com.groupdocs</groupId>
<artifactId>groupdocs-annotation-cloud</artifactId>
<version>22.2</version>
<type>pom</type>
</dependency>
快速入门
要快速入门使用GroupDocs.Annotation Cloud SDK for Java,请按以下步骤操作:
- 安装SDK: 按照上述步骤(使用Maven或从源代码安装)安装SDK。
- 配置: 使用从GroupDocs Cloud Dashboard获得的客户端ID和客户端密钥设置配置。
- 示例代码: 在您的应用程序中实现示例代码,以添加注释、提取文档信息或管理文件和文件夹。
- 文档: 参考快速入门说明和API文档,了解详细的使用示例和其他信息。
授权与认证
GroupDocs.Annotation Cloud SDK for Java使用OAuth 2.0进行授权和认证。以下提供了相关详情:
- 授权类型: OAuth 2.0
- 流程: 基于应用程序的授权
- 授权URL:
https://api.groupdocs.cloud/connect/token
- 令牌有效期: 默认情况下为1天
JWT
GroupDocs.Annotation Cloud SDK使用JSON Web Tokens (JWT) 进行安全的API访问:
- 令牌类型: OAuth 2.0 JWT (JSON Web Token)
- 授权URL: 使用
https://api.groupdocs.cloud/connect/token
端点生成令牌。 - 令牌过期: 默认令牌有效期为1天,确保对API的安全和时间限制访问。
这些详情为设置和使用GroupDocs.Annotation Cloud SDK for Java提供了全面的指南,涵盖了基本要求、安装步骤和安全配置。
以下是从提供的内容中提取的两个最具销售力的代码片段。这些片段展示了对于希望将注释功能集成到其应用程序中的潜在用户而言的基本功能。
添加点注释的云Java示例代码
该代码片段演示了如何使用GroupDocs.Annotation Cloud SDK for Java向文档添加点注释。点注释对于用评论或注释标记文档中的特定点非常有用。
// 获取完整的示例和数据文件,请访问 https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
String MyAppKey = ""; // 从 https://dashboard.groupdocs.cloud 获取AppKey和AppSID
String MyAppSid = ""; // 从 https://dashboard.groupdocs.cloud 获取AppKey和AppSID
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
AnnotateApi apiInstance = new AnnotateApi(configuration);
// 创建注释。
AnnotationInfo[] annotations = new AnnotationInfo[1];
annotations[0] = new AnnotationInfo();
Point pt = new Point();
pt.setX(1.0);
pt.setY(1.0);
annotations[0].setAnnotationPosition(pt);
Rectangle r = new Rectangle();
r.setX(100.0);
r.setY(100.0);
r.setWidth(200.0);
r.setHeight(100.0);
annotations[0].setBox(r);
annotations[0].setPageNumber(0);
annotations[0].setType(TypeEnum.POINT);
annotations[0].setText("这是一个点注释");
annotations[0].setCreatorName("Anonym A.");
// 创建请求对象。
FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("Annotationdocs\\one-page.docx");
AnnotateOptions options = new AnnotateOptions();
options.setFileInfo(fileInfo);
options.setAnnotations(Arrays.asList(annotations));
options.setOutputPath("Output/one-page-annotated.docx");
AnnotateRequest request = new AnnotateRequest(options);
// 执行API方法。
AnnotationApiLink result = apiInstance.annotate(request);
System.out.println("AddPointAnnotation: 点注释已添加: " + result.getTitle());
添加文本高亮注释的云Java示例代码
该代码片段展示了如何向文档添加文本高亮注释。文本高亮在审查过程中是一个常见的注释任务,这个片段展示了如何以编程方式实现这一点。
// 获取完整的示例和数据文件,请访问 https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
String MyAppKey = ""; // 从 https://dashboard.groupdocs.cloud 获取AppKey和AppSID
String MyAppSid = ""; // 从 https://dashboard.groupdocs.cloud 获取
AppKey和AppSID
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
AnnotateApi apiInstance = new AnnotateApi(configuration);
// 创建注释。
AnnotationInfo[] annotations = new AnnotationInfo[1];
annotations[0] = new AnnotationInfo();
Rectangle r = new Rectangle();
r.setX(100.0);
r.setY(100.0);
r.setWidth(300.0);
r.setHeight(50.0);
annotations[0].setBox(r);
annotations[0].setPageNumber(0);
annotations[0].setType(TypeEnum.TEXT_HIGHLIGHT);
annotations[0].setText("此文本已高亮显示");
annotations[0].setCreatorName("Anonym A.");
// 创建请求对象。
FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("Annotationdocs\\sample.docx");
AnnotateOptions options = new AnnotateOptions();
options.setFileInfo(fileInfo);
options.setAnnotations(Arrays.asList(annotations));
options.setOutputPath("Output/sample-annotated.docx");
AnnotateRequest request = new AnnotateRequest(options);
// 执行API方法。
AnnotationApiLink result = apiInstance.annotate(request);
System.out.println("AddTextHighlightAnnotation: 文本高亮注释已添加: " + result.getTitle());
文档注释 Java 云REST API GroupDocs.Annotation SDK API 文档管理 云 REST API 文档注释Java SDK 云文档注释 注释类型 文字注释 图像注释 形状注释 注释属性 PDF注释 Word注释 Excel注释 PowerPoint注释 图像注释 渲染文档 预览文档 删除注释 提取注释 文件管理 文件夹管理 存储管理 文件API 文件夹API 存储API 支持的文件格式 文档信息 获取页面 注释信息 注释选项 高级注释用法 区域注释 箭头注释 距离注释 椭圆注释 链接注释 点注释 折线注释 资源编辑注释 文本字段注释 文本高亮注释 文本编辑注释 文本替换注释 文本删除线注释 文本下划线注释 水印注释 波浪线注释 Microsoft Word OpenOffice Writer Microsoft Excel Microsoft PowerPoint OpenOffice Impress Microsoft Visio Microsoft Outlook AutoCAD DICOM HTML MHTML PDF 元文件 Maven 从源代码安装 JWT OAuth 2.0 授权 认证 示例代码 Java示例 快速入门 客户端ID 客户端密钥 GroupDocs Cloud 云存储 部署到Maven 安装SDK API配置