Skip to content

Commit 1af7cbd

Browse files
authored
Merge pull request #6563 from AndyButland/forms/update-record-examples
Update outdated documentation on working with Forms record data.
2 parents 2fa692c + 778f598 commit 1af7cbd

File tree

4 files changed

+43
-44
lines changed

4 files changed

+43
-44
lines changed

10/umbraco-forms/developer/working-with-data.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
meta.Title: Working with Umbraco Forms data
32
description: Developer documentation on working with Forms record data.
43
---
54

@@ -22,15 +21,15 @@ Returns all records with the state set to approved from all Forms on the Umbraco
2221
### GetApprovedRecordsFromFormOnPage
2322

2423
```csharp
25-
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
24+
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
2625
```
2726

2827
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
2928

3029
### GetApprovedRecordsFromForm
3130

3231
```csharp
33-
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
32+
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
3433
```
3534

3635
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
@@ -46,15 +45,15 @@ Returns all records from all Forms on the Umbraco page with the id = `pageId` as
4645
### GetRecordsFromFormOnPage
4746

4847
```csharp
49-
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
48+
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
5049
```
5150

5251
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
5352

5453
### GetRecordsFromForm
5554

5655
```csharp
57-
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
56+
PagedResult<IRecord> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
5857
```
5958

6059
Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.

13/umbraco-forms/developer/working-with-data.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,56 +13,56 @@ The methods can be found by injecting the `Umbraco.Forms.Core.Services.IRecordRe
1313
### GetApprovedRecordsFromPage
1414

1515
```csharp
16-
PagedResult<IRecord> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
16+
PagedResult<Record> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
1717
```
1818

1919
Returns all records with the state set to approved from all Forms on the Umbraco page with the id = `pageId` .
2020

2121
### GetApprovedRecordsFromFormOnPage
2222

2323
```csharp
24-
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
24+
PagedResult<Record> GetApprovedRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
2525
```
2626

27-
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
27+
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
2828

2929
### GetApprovedRecordsFromForm
3030

3131
```csharp
32-
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
32+
PagedResult<Record> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
3333
```
3434

35-
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
35+
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<Record>`.
3636

3737
### GetRecordsFromPage
3838

3939
```csharp
40-
PagedResult<IRecord> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
40+
PagedResult<Record> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
4141
```
4242

43-
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
43+
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
4444

4545
### GetRecordsFromFormOnPage
4646

4747
```csharp
48-
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
48+
PagedResult<Record> GetRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
4949
```
5050

51-
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
51+
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
5252

5353
### GetRecordsFromForm
5454

5555
```csharp
56-
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
56+
PagedResult<Record> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
5757
```
5858

59-
Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.
59+
Returns all records from the Form with the ID = formId as a `PagedResult<Record>`.
6060

6161
## The returned objects
6262

63-
All of these methods will return an object of type `PagedResult<IRecord>` so you can iterate through the `IRecord` objects.
63+
All of these methods will return an object of type `PagedResult<Record>` so you can iterate through the `Record` objects.
6464

65-
The properties available on a `IRecord` are:
65+
The properties available on a `Record` are:
6666

6767
```csharp
6868
int Id

14/umbraco-forms/developer/working-with-data.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,56 +13,56 @@ The methods can be found by injecting the `Umbraco.Forms.Core.Services.IRecordRe
1313
### GetApprovedRecordsFromPage
1414

1515
```csharp
16-
PagedResult<IRecord> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
16+
PagedResult<Record> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
1717
```
1818

1919
Returns all records with the state set to approved from all Forms on the Umbraco page with the id = `pageId` .
2020

2121
### GetApprovedRecordsFromFormOnPage
2222

2323
```csharp
24-
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
24+
PagedResult<Record> GetApprovedRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
2525
```
2626

27-
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
27+
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
2828

2929
### GetApprovedRecordsFromForm
3030

3131
```csharp
32-
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
32+
PagedResult<Record> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
3333
```
3434

35-
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
35+
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<Record>`.
3636

3737
### GetRecordsFromPage
3838

3939
```csharp
40-
PagedResult<IRecord> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
40+
PagedResult<Record> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
4141
```
4242

43-
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
43+
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
4444

4545
### GetRecordsFromFormOnPage
4646

4747
```csharp
48-
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
48+
PagedResult<Record> GetRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
4949
```
5050

51-
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
51+
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
5252

5353
### GetRecordsFromForm
5454

5555
```csharp
56-
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
56+
PagedResult<Record> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
5757
```
5858

59-
Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.
59+
Returns all records from the Form with the ID = formId as a `PagedResult<Record>`.
6060

6161
## The returned objects
6262

63-
All of these methods will return an object of type `PagedResult<IRecord>` so you can iterate through the `IRecord` objects.
63+
All of these methods will return an object of type `PagedResult<Record>` so you can iterate through the `Record` objects.
6464

65-
The properties available on a `IRecord` are:
65+
The properties available on a `Record` are:
6666

6767
```csharp
6868
int Id

15/umbraco-forms/developer/working-with-data.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,56 +13,56 @@ The methods can be found by injecting the `Umbraco.Forms.Core.Services.IRecordRe
1313
### GetApprovedRecordsFromPage
1414

1515
```csharp
16-
PagedResult<IRecord> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
16+
PagedResult<Record> GetApprovedRecordsFromPage(int pageId, int pageNumber, int pageSize)
1717
```
1818

1919
Returns all records with the state set to approved from all Forms on the Umbraco page with the id = `pageId` .
2020

2121
### GetApprovedRecordsFromFormOnPage
2222

2323
```csharp
24-
PagedResult<IRecord> GetApprovedRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
24+
PagedResult<Record> GetApprovedRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
2525
```
2626

27-
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
27+
Returns all records with the state set to approved from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
2828

2929
### GetApprovedRecordsFromForm
3030

3131
```csharp
32-
PagedResult<IRecord> GetApprovedRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
32+
PagedResult<Record> GetApprovedRecordsFromForm(Guid formId, int pageNumber, int pageSize)
3333
```
3434

35-
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<IRecord>`.
35+
Returns all records with the state set to approved from the Form with the ID = `formId` as a `PagedResult<Record>`.
3636

3737
### GetRecordsFromPage
3838

3939
```csharp
40-
PagedResult<IRecord> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
40+
PagedResult<Record> GetRecordsFromPage(int pageId, int pageNumber, int pageSize)
4141
```
4242

43-
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
43+
Returns all records from all Forms on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
4444

4545
### GetRecordsFromFormOnPage
4646

4747
```csharp
48-
PagedResult<IRecord> GetRecordsFromFormOnPage(int pageId, Guid.Parse("formId"), int pageNumber, int pageSize)
48+
PagedResult<Record> GetRecordsFromFormOnPage(int pageId, Guid formId, int pageNumber, int pageSize)
4949
```
5050

51-
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<IRecord>`.
51+
Returns all records from the Form with the id = `formId` on the Umbraco page with the id = `pageId` as a `PagedResult<Record>`.
5252

5353
### GetRecordsFromForm
5454

5555
```csharp
56-
PagedResult<IRecord> GetRecordsFromForm(Guid.Parse("formId"), int pageNumber, int pageSize)
56+
PagedResult<Record> GetRecordsFromForm(Guid formId, int pageNumber, int pageSize)
5757
```
5858

59-
Returns all records from the Form with the ID = formId as a `PagedResult<IRecord>`.
59+
Returns all records from the Form with the ID = formId as a `PagedResult<Record>`.
6060

6161
## The returned objects
6262

63-
All of these methods will return an object of type `PagedResult<IRecord>` so you can iterate through the `IRecord` objects.
63+
All of these methods will return an object of type `PagedResult<Record>` so you can iterate through the `Record` objects.
6464

65-
The properties available on a `IRecord` are:
65+
The properties available on a `Record` are:
6666

6767
```csharp
6868
int Id

0 commit comments

Comments
 (0)