Skip to content

Commit 7970d5b

Browse files
authored
Standardized readme.md
1 parent 2397afe commit 7970d5b

1 file changed

Lines changed: 84 additions & 50 deletions

File tree

README.md

Lines changed: 84 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,58 @@
1-
# GroupDocs.Conversion 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-conversion-cloud/groupdocs-conversion-cloud-android) [![GitHub license](https://img.shields.io/github/license/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android)](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android)
22

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

5-
## Installation
5+
[GroupDocs.Conversion Cloud SDK for Android](https://products.groupdocs.cloud/conversion/android) wraps GroupDocs.Conversion RESTful APIs so you may integrate **Document Conversion** features in your own apps with zero initial cost.
66

7-
Add Internet permission in the AndroidManifest.xml. Example:
7+
GroupDocs.Conversion Cloud API allows the developers to convert between 50+ file formats including Word documents, Excel spreadsheets, PowerPoint presentations, PDF, OpenDocument files, images & [more](https://docs.groupdocs.cloud/conversion/supported-document-formats/).
8+
9+
## Document Conversion REST API
10+
11+
- Convert the whole document to the desired target format.
12+
- Convert specific document page(s) or a page range.
13+
- Auto-detect source document format without requiring the file extension.
14+
- Load source document with extended options, such as specify password for password-protected documents.
15+
- Load specific part of the document.
16+
- Show or hide document comments.
17+
- Obtain all supported conversion formats list.
18+
- Replace missing fonts with any other font.
19+
- Add text or image watermarks to any page.
20+
- Specify resolution and quality for resultant images.
21+
- Extract metadata & basic information about the source document.
22+
- Integrated storage API.
23+
24+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/conversion/developer-guide/) to know more about GroupDocs.Conversion REST API.
25+
26+
## Microsoft File Formats
27+
28+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX\
29+
**Microsoft Excel:** XLS, XLSX, XLSB, XLSM\
30+
**Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX\
31+
**Microsoft Project:** MPP, MPT\
32+
**Microsoft Outlook:** MSG, EML\
33+
**Microsoft Visio:** VSD, VDX, VSS, VSX, VST, VTX, VSDX, VDW, VSSX, VSTX, VSDM, VSTM, VSSM\
34+
**Microsoft OneNote:** ONE
35+
36+
## Other Popular Formats
37+
38+
**Page Layout Formats:** PDF, XPS\
39+
**OpenDocument:** ODT, OTT, ODS, ODP, OTP, OTS, ODG\
40+
**CAD:** DXF, DWG, IFC, STL\
41+
**Images:** DCM, BMP, GIF, JPG, PNG, TIFF, WebP, DjVu, SVG, DNG, ICO\
42+
**Web:** HTML, MHT, MHTML\
43+
**Emails:** EML, EMLX\
44+
**eBooks:** EPUB, MOBI\
45+
**Metafile:** WMF, EMF\
46+
**LaTeX:** TEX\
47+
**Others:** TXT, RTF, CSV, TSV, XML
48+
49+
## Get Started with GroupDocs.Conversion Cloud SDK for Android
50+
51+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the installation steps as given below.
52+
53+
### Installation
54+
55+
Add Internet Permission in the AndroidManifest.xml. Example:
856

957
```xml
1058
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="<package name>">
@@ -25,58 +73,44 @@ repositories {
2573
...
2674
dependencies {
2775
...
28-
implementation 'com.groupdocs:groupdocs-conversion-cloud:20.3'
76+
implementation 'com.groupdocs:groupdocs-conversion-cloud:20.11'
2977
}
3078
```
3179

32-
## Getting Started
33-
34-
Please follow the [installation](#installation) instruction and use the following Java code:
80+
## Add Watermark while Converting DOCX to PDF
3581

3682
```java
37-
import com.groupdocs.cloud.conversion.client.*;
38-
import com.groupdocs.cloud.conversion.model.*;
39-
import com.groupdocs.cloud.conversion.api.InfoApi;
40-
41-
42-
public class ApiExample {
43-
44-
public static void getSupportedFormats() {
45-
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";
49-
50-
Configuration configuration = new Configuration(appSid, appKey);
51-
52-
InfoApi infoApi = new InfoApi(configuration);
53-
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-
}
83+
// For complete examples and data files, please go to https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java-samples
84+
// Get AppKey and AppSID from https://dashboard.groupdocs.cloud
85+
String MyAppKey = "";
86+
String MyAppSid = "";
87+
88+
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
89+
90+
// Create API instance
91+
ConvertApi apiInstance = new ConvertApi(configuration);
92+
93+
// Prepare convert settings
94+
ConvertSettings settings = new ConvertSettings();
95+
settings.setFilePath("WordProcessing/four-pages.docx");
96+
settings.setFormat("pdf");
97+
98+
WatermarkOptions watermark = new WatermarkOptions();
99+
watermark.setText("Sample watermark");
100+
watermark.setColor("Red");
101+
watermark.setWidth(100);
102+
watermark.setHeight(100);
103+
watermark.setBackground(true);
104+
105+
PdfConvertOptions convertOptions = new PdfConvertOptions();
106+
convertOptions.setWatermarkOptions(watermark);
66107
```
67108

68-
## Licensing
69-
70-
All GroupDocs.Conversion Cloud SDKs are licensed under [MIT License](LICENSE).
71-
72-
## Resources
73-
74-
+[**Website**](https://www.groupdocs.cloud)
75-
+[**Product Home**](https://products.groupdocs.cloud/conversion)
76-
+[**Documentation**](https://docs.groupdocs.cloud/conversion)
77-
+[**Free Support Forum**](https://forum.groupdocs.cloud/c/conversion)
78-
+[**Blog**](https://blog.groupdocs.cloud/category/conversion)
109+
## GroupDocs.Conversion Cloud SDKs in Popular Languages
79110

80-
## Contact Us
111+
| .NET | Java | PHP | Python | Ruby | Node.js | Android |
112+
|---|---|---|---|---|---|---|
113+
| [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android) |
114+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Conversion-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-conversion-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-conversion-cloud) | [PIP](https://pypi.org/project/groupdocs-conversion-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_conversion_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-conversion-cloud) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-conversion-cloud-android) |
81115

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

0 commit comments

Comments
 (0)