Skip to content

Commit 192bb48

Browse files
babar-razababar-raza
authored
Standardized readme.md
1 parent a4a7866 commit 192bb48

1 file changed

Lines changed: 70 additions & 43 deletions

File tree

‎README.md‎

Lines changed: 70 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,50 @@
1-
# GroupDocs.Annotation Cloud SDK for Android
1+
![](https://img.shields.io/badge/api-v2.0-lightgrey) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/groupdocs-annotation-cloud/groupdocs-annotation-cloud-android) [![GitHub license](https://img.shields.io/github/license/groupdocs-annotation-cloud/groupdocs-annotation-cloud-android)](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-android)
22

3-
This repository contains GroupDocs.Annotation Cloud SDK for Android source code. This SDK allows you to work with GroupDocs.Annotation Cloud REST APIs in your Android applications on Java language.
3+
# Annotate Documents in Android Apps with REST API
44

5-
## Installation
5+
GroupDocs.Annotation Cloud SDK for Android wraps GroupDocs.Annotation RESTful APIs so you may integrate Document Annotation features in your own Java apps with zero initial cost. The solution helps in applying annotations, sticky notes, watermark overlays, redactions, text replacements and markups to documents, presentations, emails, spreadsheets, PDF, images other file formats.
66

7-
Add Internet permission in the AndroidManifest.xml. Example:
7+
## Annotate Documents & Images in the Cloud
8+
9+
- Import document annotations.
10+
- Add or remove annotations.
11+
- Export annotated document back to its original format.
12+
- Preview document pages as images.
13+
- Fetch document information, such as, page count & file size.
14+
15+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/annotation/developer-guide/) to know more about GroupDocs.Annotation REST API.
16+
17+
## Microsoft Office Formats
18+
19+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX, RTF\
20+
**Microsoft Excel:** XLS, XLSX\
21+
**Microsoft PowerPoint:** PPT, PPTX, PPSX\
22+
**Microsoft Visio:** VSSX, VSS, VSSM, VDX, VSD, VSDX, VSDM, VSTM, VSX, VTX\
23+
**Microsoft Outlook:** EML, EMLX, MSG
24+
25+
## Other Document Formats
26+
27+
**Portable:** PDF\
28+
**OpenDocument:** ODT, OTT, ODP, OTP\
29+
**Images:** BMP, PNG, JPG, JPEG, TIFF, TIF, GIF\
30+
**Web:** MHTML\
31+
**Others:** TXT
32+
33+
## Get Started with GroupDocs.Annotation Cloud SDK for Android
34+
35+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the installation steps to get started.
36+
37+
### Installation
38+
39+
Add Internet Permission in the AndroidManifest.xml. Example:
840

941
```xml
1042
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="<package name>">
1143
<uses-permission android:name="android.permission.INTERNET" />
1244
...
1345
```
1446

15-
Add following repository and dependency to your android module's build.gradle
16-
after "apply plugin: 'com.android.application'" section:
47+
Add following repository and dependency to your android module's build.gradle after "apply plugin: 'com.android.application'" section:
1748

1849
```gradle
1950
repositories {
@@ -29,53 +60,49 @@ dependencies {
2960
}
3061
```
3162

32-
## Getting Started
33-
34-
Please follow the [installation](#installation) instruction and use the following Java code:
63+
## Add Image Annotation to DOCX in the Cloud
3564

3665
```java
37-
import com.groupdocs.cloud.annotation.client.*;
38-
import com.groupdocs.cloud.annotation.model.*;
39-
import com.groupdocs.cloud.annotation.api.InfoApi;
40-
41-
42-
public class ApiExample {
66+
// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
67+
// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
68+
String MyClientSecret = "";
69+
String MyClientId = "";
4370

44-
public static void getSupportedFormats() {
71+
Configuration configuration = new Configuration(MyClientId, MyClientSecret);
4572

46-
//TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
47-
String appSid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
48-
String appKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
73+
AnnotateApi apiInstance = new AnnotateApi(configuration);
4974

50-
Configuration configuration = new Configuration(appSid, appKey);
75+
// Create annotation/s.
76+
AnnotationInfo[] annotations = new AnnotationInfo[1];
77+
annotations[0] = new AnnotationInfo();
5178

52-
InfoApi infoApi = new InfoApi(configuration);
79+
Rectangle r = new Rectangle();
80+
r.setX(100.0);
81+
r.setY(100.0);
82+
r.setWidth(200.0);
83+
r.setHeight(100.0);
5384

54-
try {
55-
FormatsResult response = infoApi.getSupportedFileFormats();
56-
for (Format format : response.getFormats()) {
57-
System.out.println(format.getFileFormat());
58-
}
59-
} catch (ApiException e) {
60-
System.err.println("Failed to get supported file formats");
61-
e.printStackTrace();
62-
}
63-
}
64-
}
65-
```
85+
annotations[0].setBox(r);
86+
annotations[0].setImagePath("Annotationdocs\\JohnSmith.png");
87+
annotations[0].setPageNumber(0);
88+
annotations[0].setType(TypeEnum.IMAGE);
89+
annotations[0].setText("This is image annotation");
90+
annotations[0].setCreatorName("Anonym A.");
6691

67-
## Licensing
92+
// Create request object.
93+
PostAnnotationsRequest request = new PostAnnotationsRequest("Annotationdocs\\one-page.docx", Arrays.asList(annotations));
6894

69-
All GroupDocs.Annotation Cloud SDKs are licensed under [MIT License](LICENSE).
95+
// Executing api method.
96+
apiInstance.postAnnotations(request);
7097

71-
## Resources
98+
System.out.println("AddImageAnnotation: image Annotation added.");
99+
```
72100

73-
+ [**Website**](https://www.groupdocs.cloud)
74-
+ [**Product Home**](https://products.groupdocs.cloud/annotation)
75-
+ [**Documentation**](https://docs.groupdocs.cloud/annotation/)
76-
+ [**Free Support Forum**](https://forum.groupdocs.cloud/c/annotation)
77-
+ [**Blog**](https://blog.groupdocs.cloud/category/annotation)
101+
## GroupDocs.Annotation Cloud SDKs in Popular Languages
78102

79-
## Contact Us
103+
| .NET | Java | PHP | Python | Ruby | Node.js | Android |
104+
|---|---|---|---|---|---|---|
105+
| [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-dotnet) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-php) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node) | [GitHub](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-android) |
106+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Annotation-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-annotation-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-annotation-cloud) | [PIP](https://pypi.org/project/groupdocs-annotation-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_annotation_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-annotation-cloud) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-annotation-cloud-android) |
80107

81-
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/annotation).
108+
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/annotation) | [Documentation](https://docs.groupdocs.cloud/annotation/) | [Live Demo](https://products.groupdocs.app/annotation/total) | [API Reference](https://apireference.groupdocs.cloud/annotation/) | [Code Samples](https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples) | [Blog](https://blog.groupdocs.cloud/category/annotation/) | [Free Support](https://forum.groupdocs.cloud/c/annotation) | [Free Trial](https://dashboard.groupdocs.cloud)

0 commit comments

Comments
 (0)