Skip to content

Commit 5027b8c

Browse files
Merge branch 'master' of github.com:transloadit/java-sdk
2 parents 0949aa9 + 710354c commit 5027b8c

File tree

1 file changed

+11
-22
lines changed

1 file changed

+11
-22
lines changed

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[![Build Status](https://travis-ci.org/transloadit/java-sdk.png?branch=master)](https://travis-ci.org/transloadit/java-sdk)
22

33
## java-sdk
4-
A **Java** Integration for [Transloadit](https://transloadit.com)'s file uploading and encoding service
54

5+
A **Java** Integration for [Transloadit](https://transloadit.com)'s file uploading and encoding service
66

77
## Intro
88

@@ -35,7 +35,6 @@ compile 'com.transloadit.sdk:transloadit:0.0.3'
3535

3636
All interactions with the SDK begin with the `com.transloadit.sdk.Transloadit` class.
3737

38-
3938
### Create an Assembly
4039

4140
To create an assembly, you use the `newAssembly` method.
@@ -51,7 +50,7 @@ import java.util.HashMap;
5150

5251
public class Main {
5352
public static void main(String[] args) {
54-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
53+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
5554

5655
Assembly assembly = transloadit.newAssembly();
5756

@@ -80,7 +79,6 @@ public class Main {
8079
}
8180
```
8281

83-
8482
### Get an Assembly
8583

8684
The method, `getAssembly`, retrieves the JSON status of an assembly identified by the given `assembly_Id`.
@@ -93,7 +91,7 @@ import com.transloadit.sdk.response.AssemblyResponse;
9391

9492
public class Main {
9593
public static void main(String[] args) {
96-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
94+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
9795

9896
try {
9997
AssemblyResponse response = transloadit.getAssembly("ASSEMBLY_ID");
@@ -115,7 +113,6 @@ You may also get an assembly by url with the `getAssemblyByUrl` method.
115113
AssemblyResponse response = transloadit.getAssemblyByUrl("ASSEMBLY_URL");
116114
```
117115

118-
119116
### Cancel an Assembly
120117

121118
To cancel an executing assembly, you use the `cancelAssembly` method, passing the assembly id as a parameter.
@@ -128,7 +125,7 @@ import com.transloadit.sdk.response.AssemblyResponse;
128125

129126
public class Main {
130127
public static void main(String[] args) {
131-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
128+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
132129

133130
try {
134131
AssemblyResponse response = transloadit.cancelAssembly("ASSEMBLY_ID");
@@ -141,7 +138,6 @@ public class Main {
141138
}
142139
```
143140

144-
145141
### List Assemblies
146142

147143
The method, `listAssemblies`, retrieves an array of assemblies according to the given `options`. Valid `options` can be `page`,
@@ -158,7 +154,7 @@ import java.util.HashMap;
158154

159155
public class Main {
160156
public static void main(String[] args) {
161-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
157+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
162158

163159
try {
164160
Map<String, Object> options = new HashMap<>();
@@ -175,7 +171,6 @@ public class Main {
175171
}
176172
```
177173

178-
179174
### Create a Template
180175

181176
To create a new template, you use the `newTemplate` method, passing the template name as a parameter.
@@ -190,7 +185,7 @@ import java.util.HashMap;
190185

191186
public class Main {
192187
public static void main(String[] args) {
193-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
188+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
194189

195190
Template template = transloadit.newTemplate("MY_TEMPLATE_NAME");
196191

@@ -216,7 +211,6 @@ public class Main {
216211
}
217212
```
218213

219-
220214
### Update a Template
221215

222216
To update a template, you use the `updateTemplate` method, passing the template id and options to update as a parameters.
@@ -232,7 +226,7 @@ import java.util.HashMap;
232226

233227
public class Main {
234228
public static void main(String[] args) {
235-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
229+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
236230

237231
Steps steps = new Steps();
238232

@@ -255,7 +249,6 @@ public class Main {
255249
}
256250
```
257251

258-
259252
### Delete a Template
260253

261254
To delete a template, you use the `deleteTemplate` method, passing the template id as a parameter.
@@ -270,7 +263,7 @@ import java.util.HashMap;
270263

271264
public class Main {
272265
public static void main(String[] args) {
273-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
266+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
274267

275268
try {
276269
Response response = transloadit.deleteTemplate("TEMPLATE_ID");
@@ -282,7 +275,6 @@ public class Main {
282275
}
283276
```
284277

285-
286278
### List Templates
287279

288280
To get a list of all templates under your account, you use the `listTemplates` method.
@@ -295,7 +287,7 @@ import com.transloadit.sdk.response.ListResponse;
295287

296288
public class Main {
297289
public static void main(String[] args) {
298-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
290+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
299291

300292
try {
301293
ListResponse response = transloadit.listTemplates();
@@ -310,7 +302,6 @@ public class Main {
310302
}
311303
```
312304

313-
314305
### Get a template
315306

316307
To get a particular template, you use the `getTemplate` method, passing the template id as a parameter.
@@ -323,7 +314,7 @@ import com.transloadit.sdk.response.Response;
323314

324315
public class Main {
325316
public static void main(String[] args) {
326-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
317+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
327318

328319
try {
329320
AssemblyResponse response = transloadit.getTemplate("TEMPLATE_ID");
@@ -335,7 +326,6 @@ public class Main {
335326
}
336327
```
337328

338-
339329
### Get bill
340330

341331
To get your account billing details for a particular month, you use the `getBill` method, passing the month and year as parameters.
@@ -348,7 +338,7 @@ import com.transloadit.sdk.response.Response;
348338

349339
public class Main {
350340
public static void main(String[] args) {
351-
Transloadit transloadit = new Transloadit("TRANSLOADIT_KEY", "TRANSLOADIT_SECRET");
341+
Transloadit transloadit = new Transloadit("YOUR_TRANSLOADIT_KEY", "YOUR_TRANSLOADIT_SECRET");
352342

353343
try {
354344
ListResponse response = transloadit.getBill(3, 2017);
@@ -369,7 +359,6 @@ For fully working examples take a look at [examples/](https://github.com/translo
369359

370360
See [Javadoc](http://javadoc.io/doc/com.transloadit.sdk/transloadit/0.0.3) for full API documentation.
371361

372-
373362
## License
374363

375364
[The MIT License](LICENSE).

0 commit comments

Comments
 (0)