Class ApiResponse<T>

constructor

• new ApiResponse<T>(
      statusCode: number,
      message: string,
      data: T | null,
  ): ApiResponse<T>

  Type Parameters

  • T

  Parameters

  • statusCode: number

    The status code of the response.

  • message: string

    The message of the response.

  • data: T | null

    The data of the response.

  Returns ApiResponse<T>

  • A new instance of the ApiResponse class.

data

isSuccessful

message

statusCode

asAppCollectionType

• asAppCollectionType(): ApiResponse<CollectionResponse<App>>

  Returns ApiResponse<CollectionResponse<App>>

  • An ApiResponse<CollectionResponse>.

  Method

  asAppCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse>.

asAppType

• asAppType(): ApiResponse<App>

  Returns ApiResponse<App>

  • An ApiResponse.

  Method

  asAppType - Converts the ApiResponse to an ApiResponse.

asCreatedWithIdResponseType

• asCreatedWithIdResponseType<T>(): ApiResponse<CreatedWithIdResponse<T>>

  Type Parameters

  • T

  Returns ApiResponse<CreatedWithIdResponse<T>>

  • An ApiResponse<CreatedWithIdResponse>.

  Method

  asCreatedWithIdResponseType - Converts the ApiResponse to an ApiResponse<CreatedWithIdResponse>.

asFieldCollectionType

• asFieldCollectionType(): ApiResponse<CollectionResponse<Field>>

  Returns ApiResponse<CollectionResponse<Field>>

  • An ApiResponse<CollectionResponse>.

  Method

  asFieldCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse>.

asFieldType

• asFieldType(): ApiResponse<Field>

  Returns ApiResponse<Field>

  • An ApiResponse.

  Method

  asFieldType - Converts the ApiResponse to an ApiResponse.

asFileInfoType

• asFileInfoType(): ApiResponse<FileInfo>

  Returns ApiResponse<FileInfo>

  • An ApiResponse.

  Method

  asFileInfoType - Converts the ApiResponse to an ApiResponse.

asFileType

• asFileType(response: AxiosResponse): ApiResponse<File>

  Parameters

  • response: AxiosResponse

  Returns ApiResponse<File>

  • An ApiResponse.

  Method

  asFileType - Converts the ApiResponse to an ApiResponse.

asGetPagedAppsResponseType

• asGetPagedAppsResponseType(): ApiResponse<GetPagedAppsResponse>

  Returns ApiResponse<GetPagedAppsResponse>

  • An ApiResponse.

  Method

  asGetPagedAppsResponseType - Converts the ApiResponse to an ApiResponse.

asGetPagedFieldsResponseType

• asGetPagedFieldsResponseType(): ApiResponse<GetPagedFieldsResponse>

  Returns ApiResponse<GetPagedFieldsResponse>

  • An ApiResponse.

  Method

  asGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse.

asGetPagedRecordsResponseType

• asGetPagedRecordsResponseType(): ApiResponse<GetPagedRecordsResponse>

  Returns ApiResponse<GetPagedRecordsResponse>

  • An ApiResponse.

  Method

  asGetPagedRecordsResponseType - Converts the ApiResponse to an ApiResponse.

asGetPagedReportsResponseType

• asGetPagedReportsResponseType(): ApiResponse<GetPagedReportsResponse>

  Returns ApiResponse<GetPagedReportsResponse>

  • An ApiResponse.

  Method

  asGetPagedReportsResponseType - Converts the ApiResponse to an ApiResponse.

asListItemResponseType

• asListItemResponseType(): ApiResponse<ListItemResponse>

  Returns ApiResponse<ListItemResponse>

  • An ApiResponse.

  Method

  asListItemResponseType - Converts the ApiResponse to an ApiResponse.

asRecordCollectionType

• asRecordCollectionType(): ApiResponse<CollectionResponse<Record>>

  Returns ApiResponse<CollectionResponse<Record>>

  • An ApiResponse<CollectionResponse>.

  Method

  asRecordCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse>.

asRecordType

• asRecordType(): ApiResponse<Record>

  Returns ApiResponse<Record>

  • An ApiResponse.

  Method

  asRecordType - Converts the ApiResponse to an ApiResponse.

asReportDataType

• asReportDataType(): ApiResponse<ReportData>

  Returns ApiResponse<ReportData>

  • An ApiResponse.

  Method

  asReportDataType - Converts the ApiResponse to an ApiResponse.

asSaveRecordResponseType

• asSaveRecordResponseType(): ApiResponse<SaveRecordResponse>

  Returns ApiResponse<SaveRecordResponse>

  • An ApiResponse.

  Method

  asSaveRecordResponseType - Converts the ApiResponse to an ApiResponse.