Skip to content

Commit c6892c5

Browse files
committed
docs: modify example.
1 parent d787872 commit c6892c5

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -273,31 +273,35 @@ You can create field by sdk. Firstly, we need to build the property required by
273273

274274
> more detail about field type and property of field see official [API manual#create-field](https://vika.cn/developers/api/reference/#operation/create-fields)
275275
276+
create single text field example:
277+
276278
```java
277-
// Example 1: create SingleText field
278279
// build the SingleText field's property
279280
SingleTextFieldProperty singleTextFieldProperty = new SingleTextFieldProperty();
280281
singleTextFieldProperty.setDefaultValue("defaultValue");
281282
// create a CreateFieldRequest Object
282-
CreateFieldRequest<SingleTextFieldProperty> request = CreateFieldRequestBuilder
283+
CreateFieldRequest<SingleTextFieldProperty> createFieldRequest = CreateFieldRequestBuilder
283284
.create()
284-
.ofType(FieldType.SingleText)
285+
.ofType(FieldTypeEnum.SingleText)
285286
.withName("singleText")
286287
.withProperty(singleTextFieldProperty)
287288
.build();
288289
// request to create a field
289-
CreateFieldResponse response = vikaApiClient.getFieldApi().addField("space_id", "datasheet_id", request);
290+
CreateFieldResponse response = vikaApiClient.getFieldApi().addField("space_id", "datasheet_id", createFieldRequest);
291+
```
290292

291-
// Example 2: create Text field
293+
create text field example:
294+
295+
```java
292296
// if field don't require property, we can skip the process that build the property
293-
CreateFieldRequest<EmptyProperty> request = CreateFieldRequestBuilder
297+
CreateFieldRequest<EmptyProperty> createFieldRequest = CreateFieldRequestBuilder
294298
.create()
295-
.ofType(FieldType.Text)
299+
.ofType(FieldTypeEnum.Text)
296300
.withName("text")
297301
.withoutProperty()
298302
.build();
299303
// request to create a field
300-
CreateFieldResponse response = vikaApiClient.getFieldApi().addField("space_id", "datasheet_id", request);
304+
CreateFieldResponse createFieldRequest = vikaApiClient.getFieldApi().addField("space_id", "datasheet_id", createFieldRequest);
301305
```
302306

303307
#### **Detele Field**
@@ -315,13 +319,13 @@ You can create a datasheet with the help of a `CreateDatasheetRequest` Object.
315319
316320
```java
317321
// create a CreateDatasheetRequest Object
318-
CreateDatasheetRequest request = new CreateDatasheetRequest();
322+
CreateDatasheetRequest createDatasheetRequest = new CreateDatasheetRequest();
319323
// datasheet's name is required.
320324
request.setName("datasheet");
321325
// add description to datasheet
322326
request.setDescription("description");
323327
// specify the folder where the datasheet is stored
324-
request.setFolderId("fod_id");
328+
request.setFolderId("fold_id");
325329
// specify the datasheet's previous node
326330
request.setPreNodeId("pre_node_id");
327331

@@ -331,14 +335,14 @@ property.setDefaultValue("defaultValue");
331335
// a SingleText field
332336
CreateFieldRequest<SingleTextFieldProperty> singleSelectField = CreateFieldRequestBuilder
333337
.create()
334-
.ofType(FieldType.SingleText)
338+
.ofType(FieldTypeEnum.SingleText)
335339
.withName("singleSelect")
336340
.withProperty(property)
337341
.build();
338342
// a Text field
339343
CreateFieldRequest<EmptyProperty> textField = CreateFieldRequestBuilder
340344
.create()
341-
.ofType(FieldType.Text)
345+
.ofType(FieldTypeEnum.Text)
342346
.withName("text")
343347
.withoutProperty()
344348
.build();
@@ -348,7 +352,7 @@ fields.add(textField);
348352
request.setFields(fields);
349353

350354
// request to create a datasheet
351-
CreateDatasheetResponse response = vikaApiClient.getDatasheetApi().addDatasheet("space_id", request);
355+
CreateDatasheetResponse response = vikaApiClient.getDatasheetApi().addDatasheet("space_id", createDatasheetRequest);
352356
```
353357

354358
## Reporting Issues

0 commit comments

Comments
 (0)