Class EndpointFactory

EndpointFactory - A factory class for creating endpoints.

Constructors

constructor

new EndpointFactory(): EndpointFactory

Returns EndpointFactory

Methods

`Static`getAddOrUpdateListItemEndpoint

getAddOrUpdateListItemEndpoint(listId: number): string
Parameters
- listId: number
  The id of the list.
Returns string
- The add or update list item endpoint.
Method
getAddOrUpdateListItemEndpoint - Gets the add or update list item endpoint.
- Defined in models/EndpointFactory.ts:122

`Static`getAddOrUpdateRecordEndpoint

getAddOrUpdateRecordEndpoint(): string
Returns string
- The add or update record endpoint.
Method
getAddOrUpdateRecordEndpoint - Gets the add or update record endpoint.
- Defined in models/EndpointFactory.ts:191

`Static`getAppByIdEndpoint

getAppByIdEndpoint(id: number): string
Parameters
- id: number
  The id of the app.
Returns string
- The app by id endpoint.
Method
getAppByIdEndpoint - Gets the app by id endpoint.
- Defined in models/EndpointFactory.ts:26

`Static`getAppsByIdsEndpoint

getAppsByIdsEndpoint(): string
Returns string
- The apps by ids endpoint.
Method
getAppsByIdsEndpoint - Gets the apps by ids endpoint.
- Defined in models/EndpointFactory.ts:34

`Static`getAppsEndpoint

getAppsEndpoint(): string
Returns string
- The apps endpoint.
Method
getAppsEndpoint - Gets the apps endpoint.
- Defined in models/EndpointFactory.ts:17

`Static`getDeleteFileByIdEndpoint

getDeleteFileByIdEndpoint(
    recordId: number,
    fieldId: number,
    fileId: number,
): string
Parameters
- recordId: number
  The id of the record.
- fieldId: number
  The id of the field.
- fileId: number
  The id of the file.
Returns string
- The delete file by id endpoint.
Method
getDeleteFileByIdEndpoint - Gets the delete file by id endpoint.
- Defined in models/EndpointFactory.ts:86

`Static`getDeleteListItemEndpoint

getDeleteListItemEndpoint(listId: number, itemId: string): string
Parameters
- listId: number
  The id of the list.
- itemId: string
  The id of the list item.
Returns string
- The delete list item endpoint.
Method
getDeleteListItemEndpoint - Gets the delete list item endpoint.
- Defined in models/EndpointFactory.ts:132

`Static`getDeleteRecordByIdEndpoint

getDeleteRecordByIdEndpoint(appId: number, recordId: number): string
Parameters
- appId: number
  The id of the app.
- recordId: number
  The id of the record.
Returns string
- The delete record by id endpoint.
Method
getDeleteRecordByIdEndpoint - Gets the delete record by id endpoint.
- Defined in models/EndpointFactory.ts:164

`Static`getDeleteRecordsByIdsEndpoint

getDeleteRecordsByIdsEndpoint(): string
Returns string
- The delete records by ids endpoint.
Method
getDeleteRecordsByIdsEndpoint - Gets the delete records by ids endpoint.
- Defined in models/EndpointFactory.ts:199

`Static`getFieldByIdEndpoint

getFieldByIdEndpoint(id: number): string
Parameters
- id: number
  The id of the field.
Returns string
- The field by id endpoint.
Method
getRecordsEndpoint - Gets the records endpoint.
- Defined in models/EndpointFactory.ts:43

`Static`getFieldsByAppIdEndpoint

getFieldsByAppIdEndpoint(id: number): string
Parameters
- id: number
  The id of the app.
Returns string
- The fields by app id endpoint.
Method
getFieldsByAppIdEndpoint - Gets the fields by app id endpoint.
- Defined in models/EndpointFactory.ts:60

`Static`getFieldsByIdsEndpoint

getFieldsByIdsEndpoint(): string
Returns string
- The fields by ids endpoint.
Method
getFieldsByIdsEndpoint - Gets the fields by ids endpoint.
- Defined in models/EndpointFactory.ts:51

`Static`getFileByIdEndpoint

getFileByIdEndpoint(recordId: number, fieldId: number, fileId: number): string
Parameters
- recordId: number
  The id of the record.
- fieldId: number
  The id of the field.
- fileId: number
  The id of the file.
Returns string
- The file by id endpoint.
Method
getFileByIdEndpoint - Gets the file by id endpoint.
- Defined in models/EndpointFactory.ts:101

`Static`getFileInfoByIdEndpoint

getFileInfoByIdEndpoint(
    recordId: number,
    fieldId: number,
    fileId: number,
): string
Parameters
- recordId: number
  The id of the record.
- fieldId: number
  The id of the field.
- fileId: number
  The id of the file.
Returns string
- The file info by id endpoint.
Method
getRecordsEndpoint - Gets the records endpoint.
- Defined in models/EndpointFactory.ts:71

`Static`getPingEndpoint

getPingEndpoint(): string
Returns string
- The ping endpoint.
Method
getPingEndpoint - Gets the ping endpoint.
- Defined in models/EndpointFactory.ts:9

`Static`getQueryRecordsEndpoint

getQueryRecordsEndpoint(): string
Returns string
- The query records endpoint.
Method
getQueryRecordsEndpoint - Gets the query records endpoint.
- Defined in models/EndpointFactory.ts:183

`Static`getRecordByIdEndpoint

getRecordByIdEndpoint(appId: number, recordId: number): string
Parameters
- appId: number
  The id of the app.
- recordId: number
  The id of the record.
Returns string
- The get record by id endpoint.
Method
getRecordByIdEndpoint - Gets the get record by id endpoint.
- Defined in models/EndpointFactory.ts:154

`Static`getRecordsByAppIdEndpoint

getRecordsByAppIdEndpoint(appId: number): string
Parameters
- appId: number
  The id of the app.
Returns string
- The get records by app id endpoint.
Method
getRecordsByAppIdEndpoint - Gets the get records by app id endpoint.
- Defined in models/EndpointFactory.ts:144

`Static`getRecordsByIdsEndpoint

getRecordsByIdsEndpoint(): string
Returns string
- The get records by ids endpoint.
Method
getRecordsByIdsEndpoint - Gets the get records by ids endpoint.
- Defined in models/EndpointFactory.ts:175

`Static`getReportByIdEndpoint

getReportByIdEndpoint(reportId: number): string
Parameters
- reportId: number
  The id of the report.
Returns string
- The get report by id endpoint.
Method
getReportByIdEndpoint - Gets the get report by id endpoint.
- Defined in models/EndpointFactory.ts:208

`Static`getReportsByAppIdEndpoint

getReportsByAppIdEndpoint(appId: number): string
Parameters
- appId: number
  The id of the app.
Returns string
- The get reports by app id endpoint.
Method
getReportsByAppIdEndpoint - Gets the get reports by app id endpoint.
- Defined in models/EndpointFactory.ts:217

`Static`getSaveFileEndpoint

getSaveFileEndpoint(): string
Returns string
- The save file endpoint.
Method
getSaveFileEndpoint - Gets the save file endpoint.
- Defined in models/EndpointFactory.ts:113